chore: add --mockScoring flag
chore: add link to the lamassu-machine repository chore: use proper heading levels chore: add subsequent runs section
This commit is contained in:
Nikola Ubavic
parent
aff8fe373b
commit
faa075c976
3 changed files with 82 additions and 35 deletions
|
|
@ -1,8 +1,10 @@
|
|||
# Preliminaries for using nix
|
||||
# Install - nix
|
||||
|
||||
## Preliminaries for using nix
|
||||
|
||||
For a dev environment with nix package manager a postgres install on the base system is required, this guide does not cover a postgresql server running with nix-shell.
|
||||
|
||||
## Set up PostgreSQL
|
||||
### Set up PostgreSQL
|
||||
|
||||
```
|
||||
sudo -u postgres createdb lamassu
|
||||
|
|
@ -16,13 +18,13 @@ In ``psql``, run the following and set password to ``postgres123``:
|
|||
ctrl-d
|
||||
```
|
||||
|
||||
## Starting up environment
|
||||
### Starting up environment
|
||||
|
||||
shell.nix script provided, all you need to do to setup the environment is to run `nix-shell` on the folder.
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
## Install node modules
|
||||
### Install node modules
|
||||
|
||||
Make sure you're running NodeJS 8.3 or higher. Ignore any warnings.
|
||||
|
||||
|
|
@ -30,7 +32,7 @@ Make sure you're running NodeJS 8.3 or higher. Ignore any warnings.
|
|||
npm install
|
||||
```
|
||||
|
||||
## Generate certificates
|
||||
### Generate certificates
|
||||
|
||||
```
|
||||
bash tools/cert-gen.sh
|
||||
|
|
@ -39,7 +41,7 @@ bash tools/cert-gen.sh
|
|||
Notes:
|
||||
- This will create a ``.lamassu`` directory in your home directory.
|
||||
|
||||
## Set up database
|
||||
### Set up database
|
||||
|
||||
Important: lamassu-migrate currently gripes about a QueryResultError. Ignore this, it works anyway.
|
||||
|
||||
|
|
@ -47,7 +49,7 @@ Important: lamassu-migrate currently gripes about a QueryResultError. Ignore thi
|
|||
node bin/lamassu-migrate
|
||||
```
|
||||
|
||||
## Run new-lamassu-admin
|
||||
### Run new-lamassu-admin
|
||||
|
||||
```
|
||||
cd new-lamassu-admin/
|
||||
|
|
@ -55,7 +57,7 @@ npm install
|
|||
npm run start
|
||||
```
|
||||
|
||||
## Run lamassu-admin-server
|
||||
### Run lamassu-admin-server
|
||||
|
||||
In a second terminal window:
|
||||
|
||||
|
|
@ -63,7 +65,7 @@ In a second terminal window:
|
|||
node bin/lamassu-admin-server --dev
|
||||
```
|
||||
|
||||
## Register admin user
|
||||
### Register admin user
|
||||
|
||||
In a third terminal window:
|
||||
|
||||
|
|
@ -73,7 +75,7 @@ node bin/lamassu-register admin@example.com superuser
|
|||
|
||||
You'll use this generated URL in the brower in a moment.
|
||||
|
||||
## Complete configuration
|
||||
### Complete configuration
|
||||
|
||||
Paste the URL from lamassu-register exactly as output, into a browser (chrome or firefox).
|
||||
|
||||
|
|
@ -81,14 +83,35 @@ Paste the URL from lamassu-register exactly as output, into a browser (chrome or
|
|||
|
||||
Go to all the required, unconfigured red fields and choose some values. Choose mock services whenever available.
|
||||
|
||||
## Run lamassu-server
|
||||
### Run lamassu-server
|
||||
|
||||
```
|
||||
node bin/lamassu-server --mockSms
|
||||
node bin/lamassu-server --mockSms --mockScoring
|
||||
```
|
||||
|
||||
## Add a lamassu-machine
|
||||
### Add a lamassu-machine
|
||||
|
||||
Click on ``+ Add Machine`` in the sidebar. Type in a name for your machine and click **Pair**. Open up development tools to show the JavaScript console and copy the totem. You will use this to run lamassu-machine. This pairing totem expires after an hour.
|
||||
|
||||
Now continue with lamassu-machine instructions from the ``INSTALL.md`` file in lamassu-machine.
|
||||
Now continue with lamassu-machine instructions from the ``INSTALL.md`` file in [lamassu-machine repository](https://github.com/lamassu/lamassu-machine).
|
||||
|
||||
## Subsequent runs
|
||||
|
||||
To start the Lamassu server run:
|
||||
|
||||
```
|
||||
node bin/lamassu-server --mockSms --mockScoring
|
||||
```
|
||||
|
||||
To start the Lamassu Admin run:
|
||||
|
||||
```
|
||||
node bin/lamassu-admin-server --dev
|
||||
```
|
||||
|
||||
and
|
||||
|
||||
```
|
||||
cd new-lamassu-admin/
|
||||
npm run start
|
||||
```
|
||||
|
|
|
|||
60
INSTALL.md
60
INSTALL.md
|
|
@ -1,15 +1,17 @@
|
|||
# Preliminaries for Ubuntu 16.04
|
||||
# Install
|
||||
|
||||
## Preliminaries for Ubuntu 16.04
|
||||
|
||||
Installation for other distros may be slightly different. This assumes NodeJS 8.3 or higher and npm 5.6 are already installed. All of this is done in the lamassu-server directory.
|
||||
|
||||
## Packages
|
||||
### Packages
|
||||
|
||||
```
|
||||
sudo apt-get update
|
||||
sudo apt-get install postgresql postgresql-contrib postgresql-server-dev-9.5 libpq-dev git
|
||||
```
|
||||
|
||||
## Set up PostgreSQL
|
||||
### Set up PostgreSQL
|
||||
|
||||
```
|
||||
sudo -u postgres createdb lamassu
|
||||
|
|
@ -23,24 +25,24 @@ In ``psql``, run the following and set password to ``postgres123``:
|
|||
ctrl-d
|
||||
```
|
||||
|
||||
# Preliminaries for MacOS
|
||||
## Preliminaries for MacOS
|
||||
|
||||
## Postgres
|
||||
### Postgres
|
||||
|
||||
Use Postgres.app: https://postgresapp.com/
|
||||
|
||||
**psql** is automatically installed. You won't need to set up users.
|
||||
|
||||
## NodeJS
|
||||
### NodeJS
|
||||
|
||||
```
|
||||
curl -L https://git.io/n-install | bash -s -- -y lts
|
||||
. ~/.bash_profile
|
||||
```
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
## Install node modules
|
||||
### Install node modules
|
||||
|
||||
Make sure you're running NodeJS 8.3 or higher. Ignore any warnings.
|
||||
|
||||
|
|
@ -48,7 +50,7 @@ Make sure you're running NodeJS 8.3 or higher. Ignore any warnings.
|
|||
npm install
|
||||
```
|
||||
|
||||
## Generate certificates
|
||||
### Generate certificates
|
||||
|
||||
```
|
||||
bash tools/cert-gen.sh
|
||||
|
|
@ -57,7 +59,7 @@ bash tools/cert-gen.sh
|
|||
Notes:
|
||||
- This will create a ``.lamassu`` directory in your home directory.
|
||||
|
||||
## Set up database
|
||||
### Set up database
|
||||
|
||||
Important: lamassu-migrate currently gripes about a QueryResultError. Ignore this, it works anyway.
|
||||
|
||||
|
|
@ -65,7 +67,7 @@ Important: lamassu-migrate currently gripes about a QueryResultError. Ignore thi
|
|||
node bin/lamassu-migrate
|
||||
```
|
||||
|
||||
## Run new-lamassu-admin
|
||||
### Run new-lamassu-admin
|
||||
|
||||
```
|
||||
cd new-lamassu-admin/
|
||||
|
|
@ -73,7 +75,7 @@ npm install
|
|||
npm run start
|
||||
```
|
||||
|
||||
## Run lamassu-admin-server
|
||||
### Run lamassu-admin-server
|
||||
|
||||
In a second terminal window:
|
||||
|
||||
|
|
@ -81,7 +83,7 @@ In a second terminal window:
|
|||
node bin/lamassu-admin-server --dev
|
||||
```
|
||||
|
||||
## Register admin user
|
||||
### Register admin user
|
||||
|
||||
In a third terminal window:
|
||||
|
||||
|
|
@ -91,7 +93,7 @@ node bin/lamassu-register admin@example.com superuser
|
|||
|
||||
You'll use this generated URL in the brower in a moment.
|
||||
|
||||
## Complete configuration
|
||||
### Complete configuration
|
||||
|
||||
Paste the URL from lamassu-register exactly as output, into a browser (chrome or firefox).
|
||||
|
||||
|
|
@ -99,14 +101,36 @@ Paste the URL from lamassu-register exactly as output, into a browser (chrome or
|
|||
|
||||
Go to all the required, unconfigured red fields and choose some values. Choose mock services whenever available.
|
||||
|
||||
## Run lamassu-server
|
||||
### Run lamassu-server
|
||||
|
||||
```
|
||||
node bin/lamassu-server --mockSms
|
||||
node bin/lamassu-server --mockSms --mockScoring
|
||||
```
|
||||
|
||||
## Add a lamassu-machine
|
||||
### Add a lamassu-machine
|
||||
|
||||
Click on ``+ Add Machine`` in the sidebar. Type in a name for your machine and click **Pair**. Open up development tools to show the JavaScript console and copy the totem. You will use this to run lamassu-machine. This pairing totem expires after an hour.
|
||||
|
||||
Now continue with lamassu-machine instructions from the ``INSTALL.md`` file in lamassu-machine.
|
||||
Now continue with lamassu-machine instructions from the ``INSTALL.md`` file in [lamassu-machine repository](https://github.com/lamassu/lamassu-machine).
|
||||
|
||||
|
||||
## Subsequent runs
|
||||
|
||||
To start the Lamassu server run:
|
||||
|
||||
```
|
||||
node bin/lamassu-server --mockSms --mockScoring
|
||||
```
|
||||
|
||||
To start the Lamassu Admin run:
|
||||
|
||||
```
|
||||
node bin/lamassu-admin-server --dev
|
||||
```
|
||||
|
||||
and
|
||||
|
||||
```
|
||||
cd new-lamassu-admin/
|
||||
npm run start
|
||||
```
|
||||
|
|
|
|||
|
|
@ -8,12 +8,12 @@ We do not generally accept outside pull requests for new features. Please consul
|
|||
|
||||
## Installation
|
||||
|
||||
See [INSTALL.md](INSTALL.md).
|
||||
See [INSTALL.md](INSTALL.md), or [INSTALL-NIX.md](INSTALL.md) for nix environment.
|
||||
|
||||
## Installation on remote server (only for production)
|
||||
See [lamassu-remote-install/README.md](lamassu-remote-install/README.md).
|
||||
|
||||
## Running
|
||||
```bash
|
||||
node bin/lamassu-server --mockSms
|
||||
node bin/lamassu-server --mockSms --mockScoring
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue