You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/docs/Core_lightning_setup.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
1
+
2
2
3
3
## RTL Core lightning setup
4
4
@@ -10,16 +10,16 @@
10
10
*[Start the server and access the app](#start)
11
11
12
12
### <aname="intro"></a>Introduction
13
-
RTL is now enabled to manage lightning nodes running Core Lightning.
13
+
RTL is now enabled to manage lightning nodes running Core Lightning
14
14
15
-
Follow the below steps to install and setup RTL to run on Core Lightning.
15
+
Follow the below steps to install and setup RTL to run on Core Lightning
16
16
17
17
### <aname="prereq"></a>Pre-requisites:
18
18
1. Functioning Core Lightning node. Follow install instructions on their [github](https://github.com/ElementsProject/lightning)
19
19
2. NodeJS - Can be downloaded [here](https://nodejs.org/en/download)
20
-
3.clnrest - Ensure that core lightning's `clnrest` API server is configured. Configuration instructions [here](https://docs.corelightning.org/docs/rest#configuration)
21
-
4. Create/reuse a rune created by core-lightning. Check [`createrune`](https://docs.corelightning.org/reference/lightning-createrune) and [`showrunes`](https://docs.corelightning.org/reference/lightning-showrunes)commands documentation for more details.
22
-
4. Copy the `rune` and save it in a file named `.commando`, on which RTL will be installed.
20
+
3.CLNRest - Ensure that core lightning's `CLNRest` API server is configured. Configuration instructions [here](https://docs.corelightning.org/docs/rest#configuration)
21
+
4. Create/reuse core-lightning's rune. Check [`createrune`](https://docs.corelightning.org/reference/lightning-createrune) and [`showrunes`](https://docs.corelightning.org/reference/lightning-showrunes) documentation for more details on how to create runes
22
+
4. Copy the `rune` and save it in a file which must be accessible to RTL. The content of the file must be `LIGHTNING_RUNE="<your-rune>"`
23
23
24
24
### <aname="arch"></a>Architecture
25
25
@@ -49,17 +49,17 @@ $ npm install --omit=dev
49
49
If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
50
50
51
51
### <aname="prep"></a>Prep for Execution
52
-
RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app.
53
-
* Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`..
54
-
* Locate the complete path of the readable `.commando` file on your node.
52
+
RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app
53
+
* Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`
54
+
* Locate the complete path of the readable `.commando` file on your node
55
55
* Modify the RTL conf file per the example file below
56
56
57
57
Ensure that the follow values are correct per your config:
58
-
*`lnImplementation` - This should be `CLN`, indicating that RTL is connecting to a core lightning node.
59
-
*`runePath` - Path of the folder including filename which contains `rune` for the node. This rune in the file should be saved in `LIGHTNING_RUNE="your-rune"` format.
60
-
*`lnServerUrl` - complete url with ip address and port of the cl-rest server.
61
-
*`multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text.
62
-
*`configPath` (optional) - File path of the core lightning config file, if RTL server is local to the core lightning server.
58
+
*`lnImplementation` - This should be `CLN`, indicating that RTL is connecting to a core lightning node
59
+
*`runePath` - Path of the folder including **filename** which contains the `rune` for the node. The content of the file must be `LIGHTNING_RUNE="<your-rune>"`
60
+
*`lnServerUrl` - complete url with ip address and port of the CLNRest server
61
+
*`multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text
62
+
*`configPath` (optional) - File path of the core lightning config file, if RTL server is local to the core lightning server
63
63
64
64
```
65
65
{
@@ -89,7 +89,7 @@ Ensure that the follow values are correct per your config:
89
89
"logLevel": "INFO",
90
90
"fiatConversion": false,
91
91
"unannouncedChannels": false,
92
-
"lnServerUrl": "https://<cl-rest api server ip address>:3001"
92
+
"lnServerUrl": "https://<CLNRest api server ip address>:3001"
93
93
}
94
94
}
95
95
]
@@ -102,9 +102,9 @@ Run the following command:
102
102
103
103
If the server started successfully, you should get the below output on the console:
104
104
105
-
`$ Server is up and running, please open the UI at http://localhost:3000 or your proxy configured url.`
105
+
`$ Server is up and running, please open the UI at http://localhost:3000 or your proxy configured url`
106
106
107
-
Open your browser at the following address: http://localhost:3000 to access the RTL app.
107
+
Open your browser at the following address: http://localhost:3000 to access the RTL app
108
108
109
109
### Detailed config and instructions
110
-
For detailed config and access options and other information, view the main readme page.
110
+
For detailed config and access options and other information, view the main readme page
0 commit comments