From f7250ea1749167c0c8bd406c1601753291790b51 Mon Sep 17 00:00:00 2001
From: ShahanaFarooqui <shahana.farooqui@gmail.com>
Date: Sun, 26 Jan 2020 19:34:23 -0500
Subject: [PATCH] Update Application_configurations

---
 docs/Application_configurations | 65 +++++++++++++++++----------------
 1 file changed, 33 insertions(+), 32 deletions(-)

diff --git a/docs/Application_configurations b/docs/Application_configurations
index d6e1da9f..001e2d3a 100644
--- a/docs/Application_configurations
+++ b/docs/Application_configurations
@@ -1,35 +1,36 @@
 RTL allows the user to configure and control specific application parameters for app customization and integration.
-The parameters can be configured via RTL-Config.json file or through environment variables defined at the OS level.
+The parameters can be configured via RTL-Config.json file or through environment variables defined at the OS level. Required 
+parameters have `default` values for initial setup and can be updated after RTL server initial start.
 
 #### RTL-Config.json
 {
-  "multiPass": "<The password in plain text, default 'password'>",
-  "port": "<port number for the rtl node server, default '3000'>",
-  "defaultNodeIndex": <Default index to load when rtl server starts, default 1>,
+  "multiPass": "<The password in plain text, default 'password', Required>",
+  "port": "<port number for the rtl node server, default '3000', Required>",
+  "defaultNodeIndex": <Default index to load when rtl server starts, default 1, Optional>,
   "SSO": {
-    "rtlSSO": <parameter to turn SSO off/on. Allowed values - 1 (single sign on via an external cookie), 0 (stand alone RTL authentication), default 0>,
-    "rtlCookiePath": "<Full path of the cookie file including the file name. The application url needs to pass the value from this cookie file as query param 'access-key' for the SSO authentication to work, Required if SSO=1 else empty>",
-    "logoutRedirectLink": "<URL to re-direct to after logout/timeout from RTL, Required if SSO=1 else empty>"
+    "rtlSSO": <parameter to turn SSO off/on. Allowed values - 1 (single sign on via an external cookie), 0 (stand alone RTL authentication), default 0, Required>,
+    "rtlCookiePath": "<Full path of the cookie file including the file name. The application url needs to pass the value from this cookie file as query param 'access-key' for the SSO authentication to work, Required if SSO=1 else empty (Optional)>",
+    "logoutRedirectLink": "<URL to re-direct to after logout/timeout from RTL, Required if SSO=1 else empty (Optional)>"
   },
   "nodes": [
     {
-      "index": <Incrimental Node indices starting from 1>,
-      "lnNode": "<Node name to uniquely identify the node in the UI, Default 'Node 1'>",
-      "lnImplementation": "<LNP implementation, Allowed values LND/CLT. Default 'LND'>",
+      "index": <Incremental node indices starting from 1, Required>,
+      "lnNode": "<Node name to uniquely identify the node in the UI, Default 'Node 1', Required>",
+      "lnImplementation": "<LNP implementation, Allowed values LND/CLT. Default 'LND', Required>",
       "Authentication": {
-        "macaroonPath": "<Path for the folder containing 'admin.macaroon' file>",
-        "configPath": "<Optional:Full path of the lnd.conf file including the file name, if present locally or empty>"
+        "macaroonPath": "<Path for the folder containing 'admin.macaroon' file, Required>",
+        "configPath": "<Optional:Full path of the lnd.conf file including the file name, if present locally or empty, Optional>"
       },
       "Settings": {
-        "userPersona": "<User persona to tailor the data on UI. Allowed values MERCHANT, OPERATOR. Default MERCHANT>",
-        "themeMode": "<Theme modes, Allowed values DAY, NIGHT. Default DAY>",
-        "themeColor": "<Theme colors, Allowed values PURPLE, TEAL, INDIGO, PINK. Default PURPLE>",
-        "channelBackupPath": "<Optional: Path to save channel backup file. Only for LND implementation, Default <RTL root>\backup\node-1>",
-        "bitcoindConfigPath": "<Optional: path of bitcoind.conf path if available locally>",
-        "enableLogging": <parameter to turn RTL logging off/on. Allowed values - true, false, default false>,
-        "fiatConversion": <parameter to turn fiat conversion off/on. Allowed values - true, false, default false>,
-        "currencyUnit": "<Optional: Fiat current Unit for currency conversion, default 'USD' If fiatConversion is true>",
-        "lnServerUrl": "<Service url for LND/CLightning REST APIs for the node, e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. Default 'https://localhost:8080/v1'"
+        "userPersona": "<User persona to tailor the data on UI. Allowed values MERCHANT, OPERATOR. Default MERCHANT, Required>",
+        "themeMode": "<Theme modes, Allowed values DAY, NIGHT. Default DAY, Required>",
+        "themeColor": "<Theme colors, Allowed values PURPLE, TEAL, INDIGO, PINK. Default PURPLE, Required>",
+        "channelBackupPath": "<Path to save channel backup file. Only for LND implementation, Default <RTL root>\backup\node-1, Optional>",
+        "bitcoindConfigPath": "<Path of bitcoind.conf path if available locally>",
+        "enableLogging": <Parameter to turn RTL logging off/on. Allowed values - true, false, default false, Required>,
+        "fiatConversion": <parameter to turn fiat conversion off/on. Allowed values - true, false, default false, Required>,
+        "currencyUnit": "<Optional: Fiat current Unit for currency conversion, default 'USD' If fiatConversion is true, Required if fiatConversion is true>",
+        "lnServerUrl": "<Service url for LND/CLightning REST APIs for the node, e.g. https://192.168.0.1:8080/v1 OR https://192.168.0.1:3001/v1. Default 'https://localhost:8080/v1', Required"
       }
     }
   ]
@@ -38,14 +39,14 @@ The parameters can be configured via RTL-Config.json file or through environment
 #### Environment variables
 ;The environment variable can also be used for all of the above configurations except the UI settings.
 ;If the environment variables are set, it will take precedence over the parameters in the RTL-Config.json file.
-PORT (port number for the rtl node server, default 3000)
-LN_IMPLEMENTATION (LND, CLT. Default 'LND')
-LN_SERVER_URL (LND server URL for REST APIs, default https://localhost:8080/v1) OR LN_SERVER_URL (LN server URL for LNP REST APIs)
-CONFIG_PATH (Full path of the lnd.conf file including the file name) OR CONFIG_PATH (Full path of the LNP .conf file including the file name)
-MACAROON_PATH (Path for the folder containing 'admin.macaroon' file)
-RTL_SSO (1 - single sign on via an external cookie, 0 - stand alone RTL authentication)
-RTL_COOKIE_PATH (Full path of the cookie file including the file name)
-LOGOUT_REDIRECT_LINK (URL to re-direct to after logout/timeout from RTL)
-RTL_CONFIG_PATH (Path for the folder containing 'RTL-Config.json' file)
-BITCOIND_CONFIG_PATH (Full path of the bitcoind.conf file including the file name)
-CHANNEL_BACKUP_PATH (folder location for saving the channel backup files, valid for LND implementation only)
+PORT (port number for the rtl node server, default 3000, Required)
+LN_IMPLEMENTATION (LND, CLT. Default 'LND', Required)
+LN_SERVER_URL (LND server URL for REST APIs, default https://localhost:8080/v1) OR LN_SERVER_URL (LN server URL for LNP REST APIs) (Required)
+CONFIG_PATH (Full path of the lnd.conf file including the file name) OR CONFIG_PATH (Full path of the LNP .conf file including the file name) (Optional)
+MACAROON_PATH (Path for the folder containing 'admin.macaroon' file, Required)
+RTL_SSO (1 - single sign on via an external cookie, 0 - stand alone RTL authentication, Optional)
+RTL_COOKIE_PATH (Full path of the cookie file including the file name, Required if RTL_SSO=1 else Optional)
+LOGOUT_REDIRECT_LINK (URL to re-direct to after logout/timeout from RTL, Required if RTL_SSO=1 else Optional)
+RTL_CONFIG_PATH (Path for the folder containing 'RTL-Config.json' file, Required)
+BITCOIND_CONFIG_PATH (Full path of the bitcoind.conf file including the file name, Optional)
+CHANNEL_BACKUP_PATH (folder location for saving the channel backup files, valid for LND implementation only, Required if lnImplementation=LND else Optional)