Skip to content

Commit 917b7f9

Browse files
Add environment variable documentation
1 parent 5d8de34 commit 917b7f9

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,11 @@
6767
- LIGHTNING_PATH: Path for core lightning (optional; required for entrypoint.sh)
6868
- HIDDEN_SERVICE_URL: REST hidden service url (optional; for connect wallet screen; Used for Tor Domain also)
6969
- COMMANDO_CONFIG: Full Path including file name for commando auth with PUBKEY & RUNE (required)
70-
- LIGHTNING_WEBSOCKET_PORT: Core lightning's websocket port (required; from cln's config.json; starting with `bind-addr=ws:`)
70+
- LIGHTNING_WEBSOCKET_PROTOCOL: Core lightning's web socket or web socket proxy (valid values: ws/wss, default: ws)
71+
- LIGHTNING_WEBSOCKET_PORT: Core lightning's websocket port (required with default APP_CONNECT; from cln's config.json; starting with `bind-addr=ws:`/`wss-bind-addr`)
7172
- LIGHTNING_REST_PROTOCOL: Protocol on which REST is served (valid values: http/https, default: https)
7273
- LIGHTNING_REST_PORT: REST server port (required if APP_CONNECT is REST)
73-
- LIGHTNING_CERTS_DIR: Path for core lightning certificates (Required if APP_CONNECT is REST/GRPC with PROTOCOL 'https')
74+
- LIGHTNING_CERTS_DIR: Path for core lightning certificates (Required the PROTOCOL is 'https/wss')
7475
- LIGHTNING_GRPC_PROTOCOL: Core lightning's GRPC protocol (valid values: http/https, default: http)
7576
- LIGHTNING_GRPC_PORT: Core lightning's GRPC port (Required if APP_CONNECT is GRPC)
7677
```

docker-compose.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ services:
7474
LIGHTNING_GRPC_PORT: ${LIGHTNING_GRPC_PORT}
7575
LIGHTNING_REST_PORT: ${LIGHTNING_REST_PORT}
7676
LIGHTNING_WEBSOCKET_PORT: ${LIGHTNING_WEBSOCKET_PORT}
77-
APP_CORE_LIGHTNING_REST_CERT_DIR: ${APP_CORE_LIGHTNING_REST_CERT_DIR}
77+
LIGHTNING_CERTS_DIR: ${LIGHTNING_CERTS_DIR}
7878
HIDDEN_SERVICE_URL: http://${HIDDEN_SERVICE_URL}
7979
LIGHTNING_PATH: ${LIGHTNING_PATH}
8080
COMMANDO_CONFIG: ${COMMANDO_CONFIG}
@@ -113,7 +113,7 @@ services:
113113
LIGHTNING_GRPC_PORT: ${LIGHTNING_GRPC_PORT}
114114
LIGHTNING_REST_PORT: ${LIGHTNING_REST_PORT}
115115
LIGHTNING_WEBSOCKET_PORT: 2116
116-
APP_CORE_LIGHTNING_REST_CERT_DIR: ${APP_CORE_LIGHTNING_REST_CERT_DIR}
116+
LIGHTNING_CERTS_DIR: ${LIGHTNING_CERTS_DIR}
117117
HIDDEN_SERVICE_URL: http://${HIDDEN_SERVICE_URL}
118118
LIGHTNING_PATH: ${LIGHTNING_PATH}
119119
COMMANDO_CONFIG: ${COMMANDO_CONFIG}

env.sh

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ if [[ "$SETUP" == "docker" ]]; then
1919
export LIGHTNING_IP="170.21.22.3"
2020
export APP_IP="170.21.22.5"
2121
export APP_CONFIG_DIR="/data/app"
22-
export APP_CORE_LIGHTNING_REST_CERT_DIR="/c-lightning-rest/certs"
22+
export LIGHTNING_CERTS_DIR="/data/.lightning/bitcoin"
23+
export LIGHTNING_WEBSOCKET_PROTOCOL="ws"
2324
export LIGHTNING_WEBSOCKET_PORT=2106
2425
export APP_BITCOIN_RPC_USER="user"
2526
export APP_BITCOIN_RPC_PASS="password"
@@ -36,7 +37,8 @@ else
3637
export LIGHTNING_IP="localhost"
3738
export APP_IP="127.0.0.1"
3839
export APP_CONFIG_DIR="$PWD/data/app"
39-
export APP_CORE_LIGHTNING_REST_CERT_DIR="$PWD/data/c-lightning-rest/certs"
40+
export LIGHTNING_CERTS_DIR="/home/.lightning/l1-regtest/regtest"
41+
export LIGHTNING_WEBSOCKET_PROTOCOL="ws"
4042
export LIGHTNING_WEBSOCKET_PORT=5001
4143
export LIGHTNING_GRPC_PORT=5002
4244
export LIGHTNING_REST_PORT=3001

0 commit comments

Comments
 (0)