Steer

Lightning Network routing node management tool

Prerequisites

• A LND node with gRPC port available
• Elixir
• npm
• A clone of this repository

Certificates

Make sure you have a ~/.lnd folder containing

• A certificate ~/.lnd/tls.cert
• A readonly macaroon ~/.lnd/readonly.macaroon

Execution from release

wget https://github.com/RooSoft/steer/releases/download/v0.3.0/steer-v0.3.0.tgz
mkdir steer
tar zxvf steer-v0.3.0.tgz -C steer
cd steer
NODE=localhost:10009 _build/prod/rel/steer/bin/migrate
NODE=localhost:10009 _build/prod/rel/steer/bin/steer start

Execution from sources

From the project's root folder...

Prepare the app and the database

mix deps.get
mix ecto.create
mix ecto.migrate

Install assets

npm i --prefix assets
mix assets.deploy

Start steer

Usually LND's gRPC port is available from port 10009, so if running on localhost, do that command to start Steer

NODE=localhost:10009 mix phx.server

Run from sources

Browse port 4001 from the machine running Steer... can be accessed remotely.

If attempting to reach it from the same machine, simply browse to:

http://localhost:4001

Manual production build

Build

create a secret

mix phx.gen.secret

create a .env file in the root folder and make sure that those variables are configured

PORT=4000
MIX_ENV=prod
NODE=localhost:10009
DATABASE_FILE=/opt/steer/steer.db
SECRET_KEY_BASE=*** the secret created in the previous step ***

then, run this command.

export $(cat .env | xargs) && mix release

Deploy

Copy file to the production server

scp _build/prod/steer-x.y.ztar.gz steer@prod-server:.

Then unpack the tarball wherever you like, such as /opt/steer-x.y.z, cd in the folder and then migrate

bin/steer eval "Steer.Release.migrate"

And start the app

/opt/steer-x.y.z/bin/steer start