From 1e92ae760c2abbf3c7a9c7c85f5b29c852a14298 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 25 Mar 2026 20:28:11 -0700 Subject: [PATCH] Update documentation for Disable Authentication --- .github/README.md | 2 ++ .github/docs/Application_configurations.md | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index f56825cd..89be0034 100644 --- a/.github/README.md +++ b/.github/README.md @@ -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:` 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. + ### Start the Server Run the following command: diff --git a/.github/docs/Application_configurations.md b/.github/docs/Application_configurations.md index 2e89e958..59e79ee4 100644 --- a/.github/docs/Application_configurations.md +++ b/.github/docs/Application_configurations.md @@ -5,7 +5,8 @@ parameters have `default` values for initial setup and can be updated after RTL ### RTL-Config.json
``` { - "multiPass": "", + "multiPass": "", + "disableAuth": "", "port": "", "host": "", "defaultNodeIndex": , @@ -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)
HOST (host for the rtl node server, default localhost, Optional)
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)
+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)
+DISABLE_AUTH (Flag to disable authentication, NOT recommended for standalone RTL applications, only to be used by Vendors providing their own authentication service) (Optional)
LN_SERVER_URL (LN server URL for LNP REST APIs, default https://127.0.0.1:8080) (Optional)
SWAP_SERVER_URL (Swap server URL for REST APIs, default http://127.0.0.1:8081) (Optional)