From 1847e04a438c7f2c45644f88bf884e67778ffa23 Mon Sep 17 00:00:00 2001 From: Shahana Farooqui Date: Thu, 16 Jul 2020 20:44:55 -0400 Subject: [PATCH] Documentation updated for ECL lnApiPassword Documentation updated for ECL lnApiPassword --- README.md | 3 ++- connect.js | 2 +- docs/Application_configurations | 3 ++- docs/Eclair-setup.md | 8 +++++--- docs/Multi-Node-setup.md | 1 + 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6491f512..37b44147 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,8 @@ Example RTL-Config.json: "lnImplementation": "LND", "Authentication": { "macaroonPath": "", - "configPath": "" + "configPath": "", + "lnApiPassword": "" }, "Settings": { "userPersona": "OPERATOR", diff --git a/connect.js b/connect.js index 171cd03d..5708aab8 100644 --- a/connect.js +++ b/connect.js @@ -146,7 +146,7 @@ connect.validateNodeConfig = (config) => { } else { common.nodes[idx].config_path = ''; } - if (common.nodes[idx].ln_implementation === 'ECL' && common.nodes[idx].config_path !== '') { + if (common.nodes[idx].ln_implementation === 'ECL' && common.nodes[idx].ln_api_password === '' && common.nodes[idx].config_path !== '') { try { let exists = fs.existsSync(common.nodes[idx].config_path); if (exists) { diff --git a/docs/Application_configurations b/docs/Application_configurations index 7987daab..5dc88b38 100644 --- a/docs/Application_configurations +++ b/docs/Application_configurations @@ -20,7 +20,8 @@ parameters have `default` values for initial setup and can be updated after RTL "lnImplementation": "", "Authentication": { "macaroonPath": "", - "configPath": "" + "configPath": "", + "lnApiPassword": "" }, "Settings": { "userPersona": "", diff --git a/docs/Eclair-setup.md b/docs/Eclair-setup.md index 0852a624..4a922ab3 100644 --- a/docs/Eclair-setup.md +++ b/docs/Eclair-setup.md @@ -48,7 +48,8 @@ Ensure that the follow values are correct per your config: * `lnImplementation` - This should be `ECL`, indicating that RTL is connecting to an Eclair node. * `lnServerUrl` - complete url with ip address and port of the eclair server. * `multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text. -* `configPath` (Mandatory) - Full path of the folder containing `eclair.conf` including the file name for the basic password authentication through `eclair.api.password`. +* `configPath` (Optinal) - Full path of the folder containing `eclair.conf` including the file name. Can be used for the basic password authentication through `eclair.api.password`. +* `lnApiPassword` (Mandatory if configPath is missing) - The same value from eclair.conf's eclair.api.password should be provided directly here. It will be used for Eclair API authentication. ``` { @@ -64,7 +65,8 @@ Ensure that the follow values are correct per your config: "lnNode": "Eclair Testnet # 1", "lnImplementation": "ECL", "Authentication": { - "configPath": "" + "configPath": "", + "lnApiPassword": "", }, "Settings": { "userPersona": "OPERATOR", @@ -77,7 +79,7 @@ Ensure that the follow values are correct per your config: } } ], - "multiPass": + "multiPass": "" } ``` ### Start the server and access the app diff --git a/docs/Multi-Node-setup.md b/docs/Multi-Node-setup.md index 54cb7c6f..80e84dad 100644 --- a/docs/Multi-Node-setup.md +++ b/docs/Multi-Node-setup.md @@ -26,6 +26,7 @@ This step is only required to configure the nodes, which will be remotely connec 8. `lnServerUrl` must be set to the service url for LND/C Lightining REST APIs for each node, with the unique ip address of the node hosting lnd/clightning e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. In this case the ip address of the node hosting lnd/clightning is '192.168.0.1' 9. `swapServerUrl` must be set to the swap service url. e.g. http://localhost:8081/v1. 10. `configPath` and `bitcoindConfigPath` are optional parameters which can be set only if the RTL is running locally on the same node. Else it can be set to "" or removed from the conf file all together. +11. `lnApiPassword` is mandatory in the ln implementation is ECL and configPath is missing. It is used to provide password for API authentication. It will be ignored in other ln implementations. #### 3. Restart RTL