From 0aa4ee74e61341b773030f02f9f77d34bf635bfc Mon Sep 17 00:00:00 2001
From: Shahana Farooqui <shahana.farooqui@gmail.com>
Date: Wed, 24 May 2023 13:15:16 -0700
Subject: [PATCH] Document update for default/optional options

---
 .github/docs/Application_configurations.md | 24 +++++++++++-----------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/.github/docs/Application_configurations.md b/.github/docs/Application_configurations.md
index d9026040..2402bdc0 100644
--- a/.github/docs/Application_configurations.md
+++ b/.github/docs/Application_configurations.md
@@ -11,15 +11,15 @@ parameters have `default` values for initial setup and can be updated after RTL
   "defaultNodeIndex": <Default index to load when rtl server starts, default 1, Optional>,
   "dbDirectoryPath": "<Complete path of the folder where rtl database file should be saved, defults to RTL root, 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, Required>,
+    "rtlSSO": <parameter to turn SSO off/on. Allowed values - 1 (single sign on via an external cookie), 0 (stand alone RTL authentication), 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": <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/CLN/ECL. Default 'LND', Required>",
+      "lnNode": "<Node name to uniquely identify the node in the UI, Required>",
+      "lnImplementation": "<LNP implementation, Allowed values LND/CLN/ECL, Required>",
       "Authentication": {
         "macaroonPath": "<Path for the folder containing 'admin.macaroon' (LND)/'access.macaroon' (CLN) file, Required for LND & CLN>",
         "swapMacaroonPath": "<Path for the folder containing 'loop.macaroon' (LND), Required for LND Loop>",
@@ -28,16 +28,16 @@ parameters have `default` values for initial setup and can be updated after RTL
         "lnApiPassword": "<Password to be used for ECL API authentication. Mandatory only for ECL if the configPath is missing>"
       },
       "Settings": {
-        "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, YELLOW. Default PURPLE, Required>",
+        "userPersona": "<User persona to tailor the data on UI. Allowed values MERCHANT/OPERATOR. Default MERCHANT, Optional>",
+        "themeMode": "<Theme modes, Allowed values DAY, NIGHT. Default DAY, Optional>",
+        "themeColor": "<Theme colors, Allowed values PURPLE, TEAL, INDIGO, PINK, YELLOW. Default PURPLE, Optional>",
         "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>",
         "logLevel": <logging levels, will log in accordance with the logLevel value provided, Allowed values ERROR, WARN, INFO, DEBUG>,
-        "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>",
+        "fiatConversion": <parameter to turn fiat conversion off/on. Allowed values - true, false, default false, Optional>,
+        "currencyUnit": "<Optional: Fiat current Unit for currency conversion, default 'USD', Optional>",
         "unannouncedChannels": <parameter to turn off/on setting for opening announced Channels, default false, Optional>
-        "lnServerUrl": "<Service url for LND/Core Lightning REST APIs for the node, e.g. https://192.168.0.1:8080 OR https://192.168.0.1:3001 OR http://192.168.0.1:8080. Default 'https://127.0.0.1:8080', Required",
+        "lnServerUrl": "<Service url for LND/Core Lightning REST APIs for the node, e.g. https://192.168.0.1:8080 OR https://192.168.0.1:3001 OR http://192.168.0.1:8080. Default 'https://127.0.0.1:8080', Optional>
         "swapServerUrl": "<Service url for swap server REST APIs for the node, e.g. https://127.0.0.1:8081, Optional>",
         "boltzServerUrl": "<Service url for boltz server REST APIs for the node, e.g. https://127.0.0.1:9003, Optional>"
       }
@@ -50,12 +50,12 @@ parameters have `default` values for initial setup and can be updated after RTL
 The environment variable can also be used for all of the above configurations except the UI settings.<br />
 If the environment variables are set, it will take precedence over the parameters in the RTL-Config.json file.<br />
 <br />
-PORT (port number for the rtl node server, default 3000, Required)<br />
+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 />
-LN_IMPLEMENTATION (LND/CLN/ECL. Default 'LND', Required)<br />
-LN_SERVER_URL (LN server URL for LNP REST APIs, default https://127.0.0.1:8080) (Required)<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 />
 BOLTZ_SERVER_URL (Boltz server URL for REST APIs, default http://127.0.0.1:9003) (Optional)<br />
 CONFIG_PATH (Full path of the LNP .conf file including the file name) (Optional for LND & CLN, Mandatory for ECL if LN_API_PASSWORD is undefined)<br />