mirrors/Ride-The-Lightning-RTL
1
0
Fork 0
mirror of https://github.com/Ride-The-Lightning/RTL.git synced 2025-02-22 22:25:43 +01:00
Code Issues Projects Releases Wiki Activity

Update Application_configurations.md

Browse source
This commit is contained in:
saubyk 2019-02-17 16:19:44 -05:00 • committed by GitHub
parent 1d1e9b3de5
commit 04d1b245fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
Application_configurations.md
View file

@ -2,29 +2,51 @@ RTL allows the user to configure and control specific application parameters for
The parameters can be configured via RTL.conf file or through environment variables defined at the OS level.
#### RTL.conf
```
[Authentication]
macaroonPath=<Path for the folder containing 'admin.macaroon' file>
nodeAuthType=<For stand alone RTL authentication. Allowed values - CUSTOM, DEFAULT>
lndConfigPath=<Full path of the lnd.conf file including the file name>
rtlPass=<For 'nodeAuthType=CUSTOM', the password in plain text>
;Path for the folder containing 'admin.macaroon' file
macaroonPath=<>
;For stand alone RTL authentication. Allowed values - CUSTOM, DEFAULT
nodeAuthType=<>
;Full path of the lnd.conf file including the file name
lndConfigPath=<>
;For 'nodeAuthType=CUSTOM', the password in plain text
rtlPass=<>
[Settings]
flgSidenavOpened=true <Set by RTL>
flgSidenavPinned=true <Set by RTL>
menu=Vertical <Set by RTL>
menuType=Regular <Set by RTL>
theme=dark-blue <Set by RTL>
satsToBTC=false <Set by RTL>
bitcoindConfigPath=<Full path of the bitcoind.conf file including the file name>
enableLogging=<parameter to turn RTL logging off/on. Allowed values - true, false>
port=3000 <port number for the rtl node server, default 3000>
lndServerUrl=https://localhost:8080/v1 <LND server URL for REST APIs. Default is 'https://localhost:8080/v1'>
;Set by RTL
flgSidenavOpened=true
;Set by RTL
flgSidenavPinned=true
;Set by RTL
menu=Vertical
;Set by RTL
menuType=Regular
;Set by RTL
theme=dark-blue
;Set by RTL
satsToBTC=false
;Full path of the bitcoind.conf file including the file name
bitcoindConfigPath=<>
;parameter to turn RTL logging off/on. Allowed values - true, false
enableLogging=<>
;port number for the rtl node server, default 3000
port=3000
;<LND server URL for REST APIs.
;Default is 'https://localhost:8080/v1'
lndServerUrl=https://localhost:8080/v1
[SSO]
rtlSSO=0 <Single Sign On control. Allowed values - 1,0. 1-single sign on via an external cookie, 0-stand alone RTL authentication>
rtlCookiePath= <Required if 'rtlSSO=1'. Full path of the cookie file including the file name>
logoutRedirectLink=/login <Required if 'rtlSSO=1'. URL to re-direct to after logout/timeout from RTL>
```
;Single Sign On control
;Allowed values - 1,0
;1-single sign on via an external cookie
;0-stand alone RTL authentication
rtlSSO=0
;Required if 'rtlSSO=1'
;Full path of the cookie file including the file name
rtlCookiePath=<>
;Required if 'rtlSSO=1'
;URL to re-direct to after logout/timeout from RTL
logoutRedirectLink=/login
#### Environment variables