mirror of
https://github.com/Ride-The-Lightning/RTL.git
synced 2026-08-13 12:33:07 +02:00
Nodejs update for CI & Docker and updated documentation
This commit is contained in:
parent
43a46b65e1
commit
ea7f300360
8 changed files with 34 additions and 34 deletions
BIN
.DS_Store
vendored
BIN
.DS_Store
vendored
Binary file not shown.
36
.github/docs/Core_lightning_setup.md
vendored
36
.github/docs/Core_lightning_setup.md
vendored
|
|
@ -1,4 +1,4 @@
|
||||||

|

|
||||||
|
|
||||||
## RTL Core lightning setup
|
## RTL Core lightning setup
|
||||||
|
|
||||||
|
|
@ -10,16 +10,16 @@
|
||||||
* [Start the server and access the app](#start)
|
* [Start the server and access the app](#start)
|
||||||
|
|
||||||
### <a name="intro"></a>Introduction
|
### <a name="intro"></a>Introduction
|
||||||
RTL is now enabled to manage lightning nodes running Core Lightning.
|
RTL is now enabled to manage lightning nodes running Core Lightning
|
||||||
|
|
||||||
Follow the below steps to install and setup RTL to run on Core Lightning.
|
Follow the below steps to install and setup RTL to run on Core Lightning
|
||||||
|
|
||||||
### <a name="prereq"></a>Pre-requisites:
|
### <a name="prereq"></a>Pre-requisites:
|
||||||
1. Functioning Core Lightning node. Follow install instructions on their [github](https://github.com/ElementsProject/lightning)
|
1. Functioning Core Lightning node. Follow install instructions on their [github](https://github.com/ElementsProject/lightning)
|
||||||
2. NodeJS - Can be downloaded [here](https://nodejs.org/en/download)
|
2. NodeJS - Can be downloaded [here](https://nodejs.org/en/download)
|
||||||
3. clnrest - Ensure that core lightning's `clnrest` API server is configured. Configuration instructions [here](https://docs.corelightning.org/docs/rest#configuration)
|
3. CLNRest - Ensure that core lightning's `CLNRest` API server is configured. Configuration instructions [here](https://docs.corelightning.org/docs/rest#configuration)
|
||||||
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.
|
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
|
||||||
4. Copy the `rune` and save it in a file named `.commando`, on which RTL will be installed.
|
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>"`
|
||||||
|
|
||||||
### <a name="arch"></a>Architecture
|
### <a name="arch"></a>Architecture
|
||||||

|

|
||||||
|
|
@ -49,17 +49,17 @@ $ npm install --omit=dev
|
||||||
If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
|
If there is an error with `upstream dependency conflict` message then replace `npm install --omit=dev` with `npm install --omit=dev --legacy-peer-deps`.
|
||||||
|
|
||||||
### <a name="prep"></a>Prep for Execution
|
### <a name="prep"></a>Prep for Execution
|
||||||
RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app.
|
RTL requires its own config file `RTL-Config.json`, to start the server and provide user authentication on the app
|
||||||
* Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`..
|
* Rename the file `Sample-RTL-Config.json` to `RTL-Config.json` located at`./RTL`
|
||||||
* Locate the complete path of the readable `.commando` file on your node.
|
* Locate the complete path of the readable `.commando` file on your node
|
||||||
* Modify the RTL conf file per the example file below
|
* Modify the RTL conf file per the example file below
|
||||||
|
|
||||||
Ensure that the follow values are correct per your config:
|
Ensure that the follow values are correct per your config:
|
||||||
* `lnImplementation` - This should be `CLN`, indicating that RTL is connecting to a core lightning node.
|
* `lnImplementation` - This should be `CLN`, indicating that RTL is connecting to a core lightning node
|
||||||
* `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.
|
* `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>"`
|
||||||
* `lnServerUrl` - complete url with ip address and port of the cl-rest server.
|
* `lnServerUrl` - complete url with ip address and port of the CLNRest server
|
||||||
* `multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text.
|
* `multiPass` - Specify the password (in plain text) to access RTL. This password will be hashed and not stored as plain text
|
||||||
* `configPath` (optional) - File path of the core lightning config file, if RTL server is local to the core lightning server.
|
* `configPath` (optional) - File path of the core lightning config file, if RTL server is local to the core lightning server
|
||||||
|
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
|
|
@ -89,7 +89,7 @@ Ensure that the follow values are correct per your config:
|
||||||
"logLevel": "INFO",
|
"logLevel": "INFO",
|
||||||
"fiatConversion": false,
|
"fiatConversion": false,
|
||||||
"unannouncedChannels": false,
|
"unannouncedChannels": false,
|
||||||
"lnServerUrl": "https://<cl-rest api server ip address>:3001"
|
"lnServerUrl": "https://<CLNRest api server ip address>:3001"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
@ -102,9 +102,9 @@ Run the following command:
|
||||||
|
|
||||||
If the server started successfully, you should get the below output on the console:
|
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 or your proxy configured url.`
|
`$ Server is up and running, please open the UI at http://localhost:3000 or your proxy configured url`
|
||||||
|
|
||||||
Open your browser at the following address: http://localhost:3000 to access the RTL app.
|
Open your browser at the following address: http://localhost:3000 to access the RTL app
|
||||||
|
|
||||||
### Detailed config and instructions
|
### Detailed config and instructions
|
||||||
For detailed config and access options and other information, view the main readme page.
|
For detailed config and access options and other information, view the main readme page
|
||||||
|
|
|
||||||
BIN
.github/screenshots/RTL-CLN-Arch-3.png
vendored
Normal file
BIN
.github/screenshots/RTL-CLN-Arch-3.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
6
.github/workflows/checks.yml
vendored
6
.github/workflows/checks.yml
vendored
|
|
@ -33,7 +33,7 @@ jobs:
|
||||||
|
|
||||||
- name: Install NPM dependencies
|
- name: Install NPM dependencies
|
||||||
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
||||||
run: npm ci --legacy-peer-deps
|
run: npm ci
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
name: Lint
|
name: Lint
|
||||||
|
|
@ -57,7 +57,7 @@ jobs:
|
||||||
|
|
||||||
- name: Install NPM dependencies
|
- name: Install NPM dependencies
|
||||||
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
||||||
run: npm ci --legacy-peer-deps
|
run: npm ci
|
||||||
|
|
||||||
- name: Lint Scripts
|
- name: Lint Scripts
|
||||||
run: npm run lint
|
run: npm run lint
|
||||||
|
|
@ -89,7 +89,7 @@ jobs:
|
||||||
|
|
||||||
- name: Install NPM dependencies
|
- name: Install NPM dependencies
|
||||||
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
||||||
run: npm ci --legacy-peer-deps
|
run: npm ci
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: npm run test
|
run: npm run test
|
||||||
|
|
|
||||||
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
|
@ -34,7 +34,7 @@ jobs:
|
||||||
|
|
||||||
- name: Install NPM dependencies
|
- name: Install NPM dependencies
|
||||||
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
if: steps.cache-npm-packages.outputs.cache-hit != 'true'
|
||||||
run: npm ci --legacy-peer-deps
|
run: npm ci
|
||||||
|
|
||||||
- name: Cache build frontend
|
- name: Cache build frontend
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
|
|
|
||||||
|
|
@ -1,14 +1,14 @@
|
||||||
# ---------------
|
# ---------------
|
||||||
# Install Dependencies
|
# Install Dependencies
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM node:16-alpine as builder
|
FROM node:18-alpine as builder
|
||||||
|
|
||||||
WORKDIR /RTL
|
WORKDIR /RTL
|
||||||
|
|
||||||
COPY package.json /RTL/package.json
|
COPY package.json /RTL/package.json
|
||||||
COPY package-lock.json /RTL/package-lock.json
|
COPY package-lock.json /RTL/package-lock.json
|
||||||
|
|
||||||
RUN npm install --legacy-peer-deps
|
RUN npm install
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Build App
|
# Build App
|
||||||
|
|
@ -22,12 +22,12 @@ RUN npm run buildfrontend
|
||||||
RUN npm run buildbackend
|
RUN npm run buildbackend
|
||||||
|
|
||||||
# Remove non production necessary modules
|
# Remove non production necessary modules
|
||||||
RUN npm prune --production --legacy-peer-deps
|
RUN npm prune --production
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Release App
|
# Release App
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM node:16-alpine as runner
|
FROM node:18-alpine as runner
|
||||||
|
|
||||||
WORKDIR /RTL
|
WORKDIR /RTL
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# ---------------
|
# ---------------
|
||||||
# Install Dependencies
|
# Install Dependencies
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM node:16-stretch-slim as builder
|
FROM node:18-alpine as builder
|
||||||
|
|
||||||
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-armel /tini
|
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-armel /tini
|
||||||
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-armel.asc /tini.asc
|
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-armel.asc /tini.asc
|
||||||
|
|
@ -12,7 +12,7 @@ WORKDIR /RTL
|
||||||
COPY package.json /RTL/package.json
|
COPY package.json /RTL/package.json
|
||||||
COPY package-lock.json /RTL/package-lock.json
|
COPY package-lock.json /RTL/package-lock.json
|
||||||
|
|
||||||
RUN npm install --legacy-peer-deps
|
RUN npm install
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Build App
|
# Build App
|
||||||
|
|
@ -26,12 +26,12 @@ RUN npm run buildfrontend
|
||||||
RUN npm run buildbackend
|
RUN npm run buildbackend
|
||||||
|
|
||||||
# Remove non production necessary modules
|
# Remove non production necessary modules
|
||||||
RUN npm prune --production --legacy-peer-deps
|
RUN npm prune --production
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Release App
|
# Release App
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM arm32v7/node:16-stretch-slim as runner
|
FROM arm32v7/node:18-alpine as runner
|
||||||
|
|
||||||
WORKDIR /RTL
|
WORKDIR /RTL
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
# ---------------
|
# ---------------
|
||||||
# Install Dependencies
|
# Install Dependencies
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM node:16-stretch-slim as builder
|
FROM node:18-alpine as builder
|
||||||
|
|
||||||
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-arm64 /tini
|
ADD https://github.com/krallin/tini/releases/download/v0.19.0/tini-static-arm64 /tini
|
||||||
RUN chmod +x /tini
|
RUN chmod +x /tini
|
||||||
|
|
@ -11,7 +11,7 @@ WORKDIR /RTL
|
||||||
COPY package.json /RTL/package.json
|
COPY package.json /RTL/package.json
|
||||||
COPY package-lock.json /RTL/package-lock.json
|
COPY package-lock.json /RTL/package-lock.json
|
||||||
|
|
||||||
RUN npm install --legacy-peer-deps
|
RUN npm install
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Build App
|
# Build App
|
||||||
|
|
@ -25,12 +25,12 @@ RUN npm run buildfrontend
|
||||||
RUN npm run buildbackend
|
RUN npm run buildbackend
|
||||||
|
|
||||||
# Remove non production necessary modules
|
# Remove non production necessary modules
|
||||||
RUN npm prune --production --legacy-peer-deps
|
RUN npm prune --production
|
||||||
|
|
||||||
# ---------------
|
# ---------------
|
||||||
# Release App
|
# Release App
|
||||||
# ---------------
|
# ---------------
|
||||||
FROM arm64v8/node:16-stretch-slim as runner
|
FROM arm64v8/node:18-alpine as runner
|
||||||
|
|
||||||
WORKDIR /RTL
|
WORKDIR /RTL
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue