update docs

This commit is contained in:
Josh Harvey 2018-08-25 13:14:25 +02:00
parent 9fc79f1bb4
commit 0f0c070781
2 changed files with 13 additions and 22 deletions

View file

@ -31,10 +31,18 @@ Use Postgres.app: https://postgresapp.com/
**psql** is automatically installed. You won't need to set up users. **psql** is automatically installed. You won't need to set up users.
## NodeJS
```
curl -L https://git.io/n-install | bash -s -- -y lts
. ~/.bash_profile
```
# Installation # Installation
## Install node modules ## Install node modules
Ignore any warnings.
Make sure you're running the LTS version of NodeJS. Ignore any warnings.
``` ```
npm install npm install
@ -77,7 +85,7 @@ node bin/lamassu-admin-server --dev
Paste the URL from lamassu-register exactly as output, into a browser (chrome or firefox). Paste the URL from lamassu-register exactly as output, into a browser (chrome or firefox).
**Important**: the host must be localhost. Tell your browser to trust the certificate even though it's not signed by a CA. **Important**: the host must be localhost. Tell your browser to trust the certificate even though it's not signed by a recognized CA.
Go to all the required, unconfigured red fields and choose some values. Choose mock services whenever available. Go to all the required, unconfigured red fields and choose some values. Choose mock services whenever available.

View file

@ -1,29 +1,12 @@
This is part of the **Raqía** Bitcoin Machine platform.
# lamassu-server # lamassu-server
Lamassu remote server. Lamassu remote server.
## Installation ## Installation
```sh See INSTALL.md
git clone git@github.com:lamassu/lamassu-server.git
cd lamassu-server
npm install
```
## Configuration
```bash
bin/ssu config smtp2go user pass fromEmail toEmail
bin/ssu config twilio accountSid authToken fromNumber toNumber
bin/ssu set sms twilio
bin/ssu set email smtp2go
bin/ssu notify [email] [sms] # send email or sms alerts, or both
bin/ssu config notifier lowBalanceThreshold # set low balance alert, in fiat
```
## Running ## Running
```sh ```bash
node lib/app.js node bin/lamassu-server --mockSms
``` ```