GlcoinCore/RTL
1
0
Fork 0
mirror of https://github.com/Ride-The-Lightning/RTL.git synced 2026-08-13 12:33:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update documentation for Disable Authentication

Browse source
This commit is contained in:
ShahanaFarooqui 2026-03-25 20:28:11 -07:00
parent b9fa4b2998
commit 1e92ae760c
No known key found for this signature in database
GPG key ID: 951B8D133DD4AF6E
2 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/README.md vendored
View file

@ -124,6 +124,8 @@ For details on all the configuration options refer to [this page](./docs/Applica
RTL requires the user to be authenticated by the application first, before allowing access to LND functions.
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`.
For hosted solutions such as BTCPayServer, we implemented an "SSO" setup using a one-time-use cookie. For other vendors which have their own authentication service, we introduced a "disableAuth" option, which disables authentication at the RTL level. When using this option, the authentication security is the responsibility of the Vendor. This option is NOT recommended for standalone users of RTL.
### <a name="start"></a>Start the Server
Run the following command:

6
.github/docs/Application_configurations.md vendored
View file

@ -5,7 +5,8 @@ parameters have `default` values for initial setup and can be updated after RTL
### RTL-Config.json<br />
```
{
"multiPass": "<The password in plain text, default 'password', Required>",
"multiPass": "<The password in plain text, default 'password', Required if disableAuth is false>",
"disableAuth": "<The flag to disable application authentication, default 'false', Optional>",
"port": "<port number for the rtl node server, default '3000', Required>",
"host": "<host for the rtl node server, default 'all IPs', Optional>",
"defaultNodeIndex": <Default index to load when rtl server starts, default 1, Optional>,
@ -55,7 +56,8 @@ If the environment variables are set, it will take precedence over the parameter
PORT (port number for the rtl node server, default 3000, Optional)<br />
HOST (host for the rtl node server, default localhost, Optional)<br />
DB_DIRECTORY_PATH (Path for the folder where rtl database file should be saved, default RTL root directory, Optional)
APP_PASSWORD (Plaintext password to be provided by the parent container, NOT suggested for standalone RTL applications, to be used by Umbrel) (Optional)<br />
APP_PASSWORD (Plaintext password to be provided by the parent container, NOT suggested for standalone RTL applications, only to be used by Vendors providing their own authentication service) (Optional)<br />
DISABLE_AUTH (Flag to disable authentication, NOT recommended for standalone RTL applications, only to be used by Vendors providing their own authentication service) (Optional)<br /
LN_IMPLEMENTATION (LND/CLN/ECL. Default 'LND', Optional)<br />
LN_SERVER_URL (LN server URL for LNP REST APIs, default https://127.0.0.1:8080) (Optional)<br />
SWAP_SERVER_URL (Swap server URL for REST APIs, default http://127.0.0.1:8081) (Optional)<br />