Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roosoft/steer
A Lightning Network routing node management tool
https://github.com/roosoft/steer
bitcoin lightning-network
Last synced: 2 days ago
JSON representation
A Lightning Network routing node management tool
- Host: GitHub
- URL: https://github.com/roosoft/steer
- Owner: RooSoft
- Created: 2021-07-20T18:07:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-21T16:53:39.000Z (almost 2 years ago)
- Last Synced: 2023-03-22T10:57:25.164Z (over 1 year ago)
- Topics: bitcoin, lightning-network
- Language: CSS
- Homepage:
- Size: 1.85 MB
- Stars: 2
- Watchers: 4
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Steer
Lightning Network routing node management tool
## Prerequisites
- A LND node with gRPC port available
- [Elixir](https://elixir-lang.org/install.html#gnulinux)
- [npm](https://linuxconfig.org/install-npm-on-linux)
- 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
```bash
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
```bash
mix deps.get
mix ecto.create
mix ecto.migrate
```
### Install assets
```bash
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
```bash
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
```bash
mix phx.gen.secret
```
create a `.env` file in the root folder and make sure that those variables are configured
```ini
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.
```bash
export $(cat .env | xargs) && mix release
```
### Deploy
Copy file to the production server
```bash
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
```bash
bin/steer eval "Steer.Release.migrate"
```
And start the app
```bash
/opt/steer-x.y.z/bin/steer start
```