Ride-The-Lightning-RTL/RTL_setups.md

29 lines
1.5 KiB
Markdown
Raw Normal View History

2019-03-22 21:38:17 +01:00
### Documenting the different RTL setups and the corresponding config tweaks
#### RTL+LND running on the same device
2019-03-22 22:03:00 +01:00
For this type of setup, just follow the instructions on the [readme](README.md)
2019-03-22 21:38:17 +01:00
2019-03-22 21:52:03 +01:00
#### RTL and LND running on different devices (Local LAN)
If your running RTL and LND on different devices on your local LAN, certain config changes need to be made in LND and RTL conf files.
1. A static IP address must be assigned to the device running LND
2. `admin.macaroon` file must be transferred to the device on which you need to run RTL
3. Add to your lnd.conf file under the [Application Options] section: `restlisten=<ip address of the device running LND>:8080`
4. Restart LND
5. Make the following changes to the RTL.conf file
```
[Authentication]
macaroonPath=<Path of the folder containing 'admin.macaroon' on the device running RTL>
nodeAuthType=CUSTOM
rtlPass=<password in plain text>
[Settings]
2019-03-22 21:55:10 +01:00
lndServerUrl=https://<ip-address-of-device-running-lnd>:8080/v1
2019-03-22 21:52:03 +01:00
```
6. Restart RTL
2019-03-22 22:03:00 +01:00
#### RTL and LND running on different devices (with LND running on an external network or a cloud service)
2019-03-22 22:07:05 +01:00
*RTL is not recommended for this type of setup*
2019-03-22 22:07:28 +01:00
2019-03-22 22:07:05 +01:00
In case you need to run RTL with an external node, you need to ensure that RTL is served on https, by running it behind a webserver like [nginx](https://nginx.org/en/download.html) encrypted with your [letsencrypt](https://letsencrypt.org) certificate.
2019-03-22 22:07:28 +01:00
2019-03-22 22:03:00 +01:00
We have not provided a standardized guide for this setup. A documentation PR is welcome for this.