You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
184 lines
8.1 KiB
Markdown
184 lines
8.1 KiB
Markdown
6 years ago
|
## Ride The Lightning (RTL)
|
||
3 years ago
|
![](../screenshots/RTL-LND-Dashboard.png)
|
||
6 years ago
|
|
||
5 years ago
|
<a href="https://snyk.io/test/github/Ride-The-Lightning/RTL"><img src="https://snyk.io/test/github/Ride-The-Lightning/RTL/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/Ride-The-Lightning/RTL" style="max-width:100%;"></a>
|
||
6 years ago
|
[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/DAVFoundation/captain-n3m0/blob/master/LICENSE)
|
||
6 years ago
|
|
||
3 years ago
|
**Intro** -- [Application Features](Application_features.md) -- [Road Map](Roadmap.md) -- [Application Configurations](Application_configurations) -- [C-Lightning](C-Lightning-setup.md) -- [Eclair](Eclair-setup.md) -- [Contribution](Contributing.md)
|
||
6 years ago
|
|
||
6 years ago
|
* [Introduction](#intro)
|
||
6 years ago
|
* [Architecture](#arch)
|
||
6 years ago
|
* [Prerequisites](#prereq)
|
||
|
* [Installation](#install)
|
||
|
* [Prep For Execution](#prep)
|
||
|
* [Start The Server](#start)
|
||
|
* [Access The Application](#access)
|
||
|
* [Troubleshooting](#trouble)
|
||
|
|
||
|
### <a name="intro"></a>Introduction
|
||
5 years ago
|
RTL is a full function, device agnostic, web user interface to help manage lightning node operations.
|
||
4 years ago
|
RTL is available on [LND](https://github.com/lightningnetwork/lnd), [C-Lightning](https://github.com/ElementsProject/lightning) and [Eclair](https://github.com/ACINQ/eclair) implementations.
|
||
5 years ago
|
|
||
3 years ago
|
* C-Lightning users, refer to [this](C-Lightning-setup.md) page for install instructions.
|
||
|
* Eclair users, refer to [this](Eclair-setup.md) page for install instructions.
|
||
4 years ago
|
* LND users, follow the instructions below
|
||
5 years ago
|
|
||
|
Lightning Network Daemon(LND) is an implementation of Lightning Network BOLT protocol by [Lightning Labs](https://lightning.engineering/).
|
||
6 years ago
|
|
||
4 years ago
|
Pre-requisite for running RTL is a functioning and synced LND node. If you are a Raspberry Pi or a Linux user, you can follow the famous Stadicus's [guide](https://stadicus.github.io/RaspiBolt/) to setup a Bitcoin + Lighting node.
|
||
6 years ago
|
|
||
5 years ago
|
RTL is available on the below platforms/services:
|
||
6 years ago
|
* [RaspiBlitz](https://github.com/rootzoll/raspiblitz)
|
||
|
* [Nodl](https://www.nodl.it/)
|
||
|
* [BTCPayserver](https://github.com/btcpayserver/btcpayserver-docker)
|
||
5 years ago
|
* [Blockdaemon](https://blockdaemon.com/bitcoin-lightning-protocol-details)
|
||
|
* [myNode](http://mynodebtc.com)
|
||
|
* [Lux Node](https://luxnode.io/product/lux-node/)
|
||
4 years ago
|
* [BCubium](https://bgeometrics.com)
|
||
4 years ago
|
* [Start9Labs](https://start9labs.com)
|
||
4 years ago
|
* [Umbrel](https://github.com/getumbrel/umbrel)
|
||
6 years ago
|
|
||
6 years ago
|
Docker Image: https://hub.docker.com/r/shahanafarooqui/rtl
|
||
|
|
||
6 years ago
|
### <a name="arch"></a>Architecture
|
||
3 years ago
|
![](../screenshots/RTL-LND-Arch-2.png)
|
||
6 years ago
|
|
||
6 years ago
|
### <a name="prereq"></a>Prerequisites
|
||
6 years ago
|
* Functioning and synced LND lightning node.
|
||
|
* Node.js, which can be downloaded [here](https://nodejs.org/en/download/)
|
||
|
* Recommended Browsers: Chrome, Firefox, MS Edge
|
||
6 years ago
|
|
||
6 years ago
|
### <a name="install"></a>Installation
|
||
4 years ago
|
To download a specific RTL version follow the instructions on the [release page](https://github.com/Ride-The-Lightning/RTL/releases)
|
||
6 years ago
|
|
||
4 years ago
|
To download from master (*not recommended*):
|
||
4 years ago
|
#### First time setup
|
||
|
```
|
||
|
$ git clone https://github.com/Ride-The-Lightning/RTL.git
|
||
|
$ cd RTL
|
||
|
$ npm install --only=prod
|
||
|
```
|
||
5 years ago
|
#### Or: Update existing dependencies
|
||
6 years ago
|
```
|
||
6 years ago
|
$ cd RTL
|
||
6 years ago
|
$ git reset --hard HEAD
|
||
|
$ git clean -f -d
|
||
|
$ git pull
|
||
5 years ago
|
$ npm install --only=prod
|
||
6 years ago
|
```
|
||
6 years ago
|
### <a name="prep"></a>Prep for Execution
|
||
5 years ago
|
RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app.
|
||
6 years ago
|
|
||
3 years ago
|
*Advanced users can refer to [this page](Multi-Node-setup.md), for config settings required to manage multiple nodes*
|
||
5 years ago
|
|
||
3 years ago
|
* Copy the file `Sample-RTL-Config.json` from `./RTL/docs` to `./RTL` and rename it to `RTL-Config.json`.
|
||
6 years ago
|
* Locate the complete path of the readable macroon file (admin.macroon) on your node and the lnd.conf file.
|
||
5 years ago
|
* Modify the `RTL-Config.json` file per the example file below
|
||
6 years ago
|
|
||
5 years ago
|
Example RTL-Config.json:
|
||
6 years ago
|
```
|
||
5 years ago
|
{
|
||
|
"multiPass": "password",
|
||
|
"port": "3000",
|
||
|
"defaultNodeIndex": 1,
|
||
|
"SSO": {
|
||
|
"rtlSSO": 0,
|
||
|
"rtlCookiePath": "",
|
||
|
"logoutRedirectLink": ""
|
||
|
},
|
||
|
"nodes": [
|
||
|
{
|
||
|
"index": 1,
|
||
|
"lnNode": "LND Testnet",
|
||
|
"lnImplementation": "LND",
|
||
|
"Authentication": {
|
||
4 years ago
|
"macaroonPath": "<Complete path of the folder containing LND's admin.macaroon for the node # 1>",
|
||
|
"swapMacaroonPath": "<Complete path of the folder containing Loop's loop.macaroon for the node>",
|
||
|
"boltzMacaroonPath": "<Complete path of the folder containing Boltz admin.macaroon for the node>",
|
||
4 years ago
|
"configPath": "<Optional:Path of the .conf if present locally or empty>",
|
||
|
"lnApiPassword": "<Optional:Can be used to provide password in ECL implementation>"
|
||
5 years ago
|
},
|
||
|
"Settings": {
|
||
|
"userPersona": "OPERATOR",
|
||
|
"themeMode": "DAY",
|
||
|
"themeColor": "PURPLE",
|
||
|
"channelBackupPath": "C:\\RTL\\backup\\node-1",
|
||
|
"bitcoindConfigPath": "<Optional: path of bitcoind.conf path if available locally>",
|
||
|
"enableLogging": true,
|
||
|
"fiatConversion": false,
|
||
4 years ago
|
"lnServerUrl": "<url for LND REST APIs for node #1 e.g. https://192.168.0.1:8080>",
|
||
4 years ago
|
"swapServerUrl": "<url for swap server REST APIs for the node. e.g. https://localhost:8081>",
|
||
|
"boltzServerUrl": "<url for boltz server REST APIs for the node. e.g. https://localhost:9003>"
|
||
5 years ago
|
}
|
||
|
}
|
||
|
]
|
||
|
}
|
||
6 years ago
|
```
|
||
3 years ago
|
For details on all the configuration options refer to [this page](./Application_configurations).
|
||
6 years ago
|
|
||
6 years ago
|
#### User Authentication on RTL
|
||
6 years ago
|
RTL requires the user to be authenticated by the application first, before allowing access to LND functions.
|
||
5 years ago
|
Specific password must be provided in RTL-Config.json (in plain text) for authentication. Password should be set with `multiPass:<user defined>` in the `Authentication` section of RTL-Config.json. Default initial password is `password`.
|
||
6 years ago
|
|
||
6 years ago
|
### <a name="start"></a>Start the Server
|
||
6 years ago
|
Run the following command:
|
||
6 years ago
|
|
||
6 years ago
|
`$ node rtl`
|
||
6 years ago
|
|
||
|
If the server started successfully, you should get the below output on the console:
|
||
|
|
||
6 years ago
|
`$ Server is up and running, please open the UI at http://localhost:3000`
|
||
6 years ago
|
|
||
6 years ago
|
#### Optional: Running RTL as a service (Rpi or Linux platform users)
|
||
|
In case you are running a headless Rpi or a Linux node, you can configure RTL as a service.
|
||
6 years ago
|
|
||
6 years ago
|
* Create RTL systemd unit and with the following content. Save and exit.
|
||
6 years ago
|
```bash
|
||
|
# Raspibolt RTL: systemd unit for RTL
|
||
|
# /etc/systemd/system/RTL.service
|
||
6 years ago
|
|
||
|
[Unit]
|
||
|
Description=RTL daemon
|
||
|
Wants=lnd.service
|
||
6 years ago
|
After=lnd.service
|
||
6 years ago
|
|
||
6 years ago
|
[Service]
|
||
6 years ago
|
ExecStart=/usr/bin/node <Full path of the RTL folder>/rtl
|
||
6 years ago
|
User=<user>
|
||
6 years ago
|
Restart=always
|
||
|
TimeoutSec=120
|
||
|
RestartSec=30
|
||
|
|
||
|
[Install]
|
||
|
WantedBy=multi-user.target
|
||
6 years ago
|
```
|
||
6 years ago
|
|
||
6 years ago
|
* enable and start RTL
|
||
6 years ago
|
```
|
||
|
$ sudo systemctl enable RTL
|
||
|
$ sudo systemctl start RTL
|
||
|
```
|
||
6 years ago
|
* montior the RTL log file in realtime(exit with Ctrl-C)
|
||
6 years ago
|
|
||
6 years ago
|
`$ sudo journalctl -f -u RTL`
|
||
6 years ago
|
|
||
6 years ago
|
### <a name="access"></a>Accessing the Application
|
||
6 years ago
|
You can access the application in multiple setups (Please make note of the 4th exception):
|
||
6 years ago
|
1. Same device as the server:
|
||
6 years ago
|
Open your browser at the following address: http://localhost:3000 to access the RTL application.
|
||
6 years ago
|
|
||
6 years ago
|
2. Remotely from another device on the same local network (home network) as the node(RTL server+LND running on the same device):
|
||
6 years ago
|
* Ensure that the if a firewall running on your node, it allows access on port 3000 (or the custom port configured for RTL).
|
||
|
* Determine the IP address of your node to access the application.
|
||
6 years ago
|
E.g. if the IP address of your node is 192.168.0.15 then open your browser at the following address: http://192.168.0.15:3000 to access RTL.
|
||
6 years ago
|
|
||
3 years ago
|
3. Config tweaks for running RTL server and LND on separate devices on the same network can be found [here](RTL_setups.md).
|
||
6 years ago
|
|
||
6 years ago
|
4. Any Other setup: **Please be advised, if you are accessing your node remotely via RTL, its critical to encrypt the communication via use of https. You can use solutions like nginx and letsencrypt or TOR to setup secure access for RTL.**
|
||
3 years ago
|
- Sample SSL setup guide can be found [here](RTL_SSL_setup.md)
|
||
|
- (For advanced users) A sample SSL guide to serve remote access over an encrypted Tor connection can be found [here](RTL_TOR_setup.md)
|
||
6 years ago
|
|
||
6 years ago
|
### <a name="trouble"></a>Troubleshooting
|
||
6 years ago
|
In case you are running into issues with the application or if you have feedback, feel free to open issues on our github repo.
|
||
5 years ago
|
You can also reach out to us via twitter DM on [@Suheb__](https://twitter.com/Suheb__) or [@RTL_App](https://twitter.com/RTL_App). Thanks for your interest.
|