From 037bc749e02544876850d519b6ab1efae1991d0a Mon Sep 17 00:00:00 2001 From: saubyk <39208279+saubyk@users.noreply.github.com> Date: Sun, 24 Feb 2019 18:16:11 -0500 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 183d47fe..cd729e69 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Fetch the dependencies and build the application by running: `$ npm install` -#### Updating existing build +#### Or: Updating existing build ``` $ cd RTL $ git reset --hard HEAD @@ -95,24 +95,24 @@ port=3000 For details on all the configuration options refer to [this page](https://github.com/ShahanaFarooqui/RTL/blob/master/Application_configurations). #### User Authentication on RTL -RTL requires the user to be authenticated by RTL first, before accessing LND functions. +RTL requires the user to be authenticated by the application first, before accessing LND functions. There are two options to configure authentication on RTL, depending on the `nodeAuthtype` value provided in RTL.conf. For `nodeAuthType=DEFAULT` Password provided in lnd.conf for the rpc setting for bitcoind will be used for authentication. For `nodeAuthType=CUSTOM` -Specific password can be provided in RTL.conf (in plain text), to be used by RTL for authentication. +Specific password must be provided in RTL.conf (in plain text) for authentication. Password should be set with `rtlPass=` in the [Authentication] section of RTL.conf ### Start the Server Run the following command: -`node rtl` +`$ node rtl` If the server started successfully, you should get the below output on the console: -`Server is up and running, please open the UI at http://localhost:3000` +`$ Server is up and running, please open the UI at http://localhost:3000` #### Optional: Running RTL as a service (rpi or Linux platform users) In case you are running a headless rpi or Linux node, you can configure RTL as a service.