V25.07

.github/workflows/release.yml

@@ -1,39 +1,11 @@
-name: Build artifact and package
+name: Build and Release Pakage
 
 on:
   release:
     types: [released]
   workflow_dispatch:
 
 jobs:
-  artifact:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout source code
-        uses: actions/checkout@v3
-
-      - name: Cache build frontend
-        uses: actions/cache@v3
-        id: cache-build-frontend
-        with:
-          path: apps/frontend
-          key: ${{ runner.os }}-frontend-${{ github.sha }}
-
-      - name: Cache build backend
-        uses: actions/cache@v3
-        id: cache-build-backend
-        with:
-          path: apps/backend
-          key: ${{ runner.os }}-backend-${{ github.sha }}
-
-      - name: Compress files
-        run: tar -czf /tmp/clnapp.tar.gz apps/frontend/build apps/backend/dist package.json package-lock.json
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: clnapp-build$VERSION
-          path: /tmp/clnapp.tar.gz
-
   build:
     name: Build image
     runs-on: ubuntu-22.04

.gitignore

@@ -6,3 +6,5 @@ application-cln.log
 .commando
 release
 env-local.sh
+apps/frontend/build
+apps/backend/dist

README.md

@@ -39,46 +39,66 @@
       tar -xzf v0.0.1.tar.gz
       ```
 
-  - ### Dependency Installation
+  - ### Dependency Installation and Compile
 
     ```
     cd cln-application-0.0.1
-    npm install --force --omit=dev
+    npm install
+    npm run build
+    npm prune --omit=dev
     ```
 
   - ### Environment Variables
       This application accepts & depends upon these variables to be passed through environment:
 
       ```
-      - SINGLE_SIGN_ON: Flag to bypass application level authentication (valid values: true/false, default: false)
-      - LOCAL_HOST: Device url for connect url links (optional; for connect wallet screen)
-      - DEVICE_DOMAIN_NAME: Device name/IP for lnmessage connect url feature (optional; for connect wallet screen)
-      - BITCOIN_NODE_IP: IP address of bitcoin node container (required)
-      - BITCOIN_NETWORK: Bitcoin network type (optional; for entrypoint.sh; valid values: bitcoin/signet/testnet/regtest)
-      - APP_CONFIG_DIR: Path for cln-application's configuration file (required; config.json)
-      - APP_MODE: Mode for logging and other settings (valid values: production/development/testing, default: production)
-      - APP_CONNECT: Choose how to connect to CLN (valid values: COMMANDO/REST/GRPC, default: COMMANDO)
-      - APP_PROTOCOL: Protocol on which the application will be served (valid values: http/https, default: http)
-      - APP_IP: IP address of this application (cln-application) container (required)
-      - APP_PORT: Port on which this application should be served (required)
-      - LIGHTNING_IP: IP address of Core lightning node container (required)
-      - LIGHTNING_PATH: Path for core lightning (optional; required for entrypoint.sh)
-      - HIDDEN_SERVICE_URL: REST hidden service url (optional; for connect wallet screen; Used for Tor Domain also)
-      - COMMANDO_CONFIG: Full Path including file name for commando auth with PUBKEY & RUNE (required)
-      - LIGHTNING_WEBSOCKET_PORT: Core lightning's websocket port (required; from cln's config.json; starting with `bind-addr=ws:`)
-      - LIGHTNING_REST_PROTOCOL: Protocol on which REST is served (valid values: http/https, default: https)
-      - LIGHTNING_REST_PORT: REST server port (required if APP_CONNECT is REST)
-      - LIGHTNING_CERTS_DIR: Path for core lightning certificates (Required if APP_CONNECT is REST/GRPC with PROTOCOL 'https')
-      - LIGHTNING_GRPC_PROTOCOL: Core lightning's GRPC protocol (valid values: http/https, default: http)
-      - LIGHTNING_GRPC_PORT: Core lightning's GRPC port (Required if APP_CONNECT is GRPC)
+      - BITCOIN_HOST: Hostname/IP address of bitcoin node container (configurable to run lightningd with `--bitcoin-rpcconnect`, default: `localhost`)
+      - BITCOIN_NETWORK: Bitcoin network type (for entrypoint.sh and lightningd with `--network`; valid values: bitcoin/signet/testnet/regtest; default: `bitcoin`)
+
+      - APP_SINGLE_SIGN_ON: Flag to bypass application level authentication (valid values: true/false, default: false)
+      - APP_PROTOCOL: Protocol on which the application will be served (valid values: http/https, default: `http`)
+      - APP_HOST: Hostname/IP address of cln-application's container (default: `localhost`)
+      - APP_PORT: Port on which this application should be served (default: `2103`)
+
+      - APP_CONFIG_FILE: Path for cln-application's configuration file (default: `./config.json`)
+      - APP_LOG_FILE: Path for cln-application's log file (default: `./application-cln.log`)
+      - APP_MODE: Mode for logging and other settings (valid values: production/development/testing, default: `production`)
+      - APP_CONNECT: Choose how to connect to CLN (valid values: COMMANDO/REST/GRPC, default: `COMMANDO`)
+
+      - LIGHTNING_DATA_DIR: Path for core lightning (used by entrypoint.sh, default: ``)
+      - LIGHTNING_HOST: IP address of Core lightning node container (used for `COMMANDO` APP_CONNECT, default: `localhost`)
+      - LIGHTNING_TOR_HOST: REST hidden service url (default: ``)
+
+      - LIGHTNING_VARS_FILE: Full Path including the file name for connection auth with LIGHTNING_PUBKEY & LIGHTNING_RUNE (defult: `./.commando-env`)
+      - LIGHTNING_WS_PROTOCOL: Core lightning's web socket is serving on ws or serving via WSSProxy (valid values: ws/wss, default: `ws`)
+      - LIGHTNING_WS_PORT: Core lightning's websocket port (used by `COMMANDO` APP_CONNECT; with `bind-addr=ws:`/`wss-bind-addr` in CLN config; default: `5001`)
+      - LIGHTNING_WS_CLIENT_KEY_FILE: Client key file path including file name for websocket TLS authentication (used by `COMMANDO` APP_CONNECT and `wss` LIGHTNING_WS_PROTOCOL; default: `./client-key.pem`)
+      - LIGHTNING_WS_CLIENT_CERT_FILE: Client certificate file path including file name for websocket TLS authentication (used by `COMMANDO` APP_CONNECT and `wss` LIGHTNING_WS_PROTOCOL; default: `./client.pem`)
+      - LIGHTNING_WS_CA_CERT_FILE: CA certificate file path including file name for websocket TLS authentication (default: `./ca.pem`)
+
+      - LIGHTNING_REST_PROTOCOL: Protocol on which REST is served (valid values: http/https, default: `https`)
+      - LIGHTNING_REST_HOST: IP address/hostname of Core Lightning REST interface (used if APP_CONNECT is `REST`, default: `localhost`)
+      - LIGHTNING_REST_TOR_HOST: Tor hidden service URL for Core Lightning REST interface (default: ``)
+      - LIGHTNING_REST_PORT: REST server port (used if APP_CONNECT is `REST`; default: `3010`)
+      - LIGHTNING_REST_CLIENT_KEY_FILE: Client key file path including file name for REST TLS authentication (default: `./client-key.pem`)
+      - LIGHTNING_REST_CLIENT_CERT_FILE: Client certificate file path including file name for REST TLS authentication (default: `./client.pem`)
+      - LIGHTNING_REST_CA_CERT_FILE: CA certificate file path including file name for REST TLS authentication (used by `REST` APP_CONNECT and `https` LIGHTNING_REST_PROTOCOL; default: `./ca.pem`)
+
+      - LIGHTNING_GRPC_HOST: IP address/hostname of Core Lightning GRPC interface (used if APP_CONNECT is `GRPC`, default: `localhost`)
+      - LIGHTNING_GRPC_TOR_HOST: Tor hidden service URL for Core Lightning GRPC interface (default: ``)
+      - LIGHTNING_GRPC_PORT: Core lightning's GRPC port (used if APP_CONNECT is `GRPC`; default: `9736`)
+      - LIGHTNING_GRPC_PROTO_PATH: URL to directory containing CLN gRPC protocol definitions (default: `https://github.com/ElementsProject/lightning/tree/master/cln-grpc/proto`)
+      - LIGHTNING_GRPC_CLIENT_KEY_FILE: Client key file path including file name for GRPC TLS authentication (used by `GRPC` APP_CONNECT; default: `./client-key.pem`)
+      - LIGHTNING_GRPC_CLIENT_CERT_FILE: Client certificate file path including file name for GRPC TLS authentication (used by `GRPC` APP_CONNECT; default: `./client.pem`)
+      - LIGHTNING_GRPC_CA_CERT_FILE: CA certificate file path including file name for GRPC TLS authentication (used by `GRPC` APP_CONNECT; default: `./ca.pem`)
       ```
 
       Set these variables either via terminal OR by env.sh script OR by explicitly loading variables from .env files.
-      Important Note: Environment variables take precedence over config.json variables. Like `SINGLE_SIGN_ON` will take higher precedence over 
+      Important Note: Environment variables take precedence over config.json variables. Like `APP_SINGLE_SIGN_ON` will take higher precedence over 
       `singleSignOn` from config.json.
 
   - ### Application Configuration
-      This is the config.json file which is required by application's frontend. If the file named `config.json` is missing at `APP_CONFIG_DIR` location, one like below will be auto created:
+      This is the default `config.json` file which is required by application's frontend. If the file `APP_CONFIG_FILE` is missing at the location, one like below will be auto created:
 
       ```
         {
@@ -94,8 +114,8 @@
 
   - ### Commando Authentication
       - This application utilizes [lnmessage](https://github.com/aaronbarnardsound/lnmessage) and [commando](https://docs.corelightning.org/reference/lightning-commando) for connecting with core lightning node. The connection is trustless and end-to-end encrypted. Commando manages authentication and authorization through runes, which can grant either full or fine-grained permissions. 
-      - The backend server reads `LIGHTNING_PUBKEY` & `LIGHTNING_RUNE` from the `COMMANDO_CONFIG` file for this communication. 
-      - Values can either be set manually or script `entrypoint.sh` can be used to call `getinfo` and `createrune` methods and save values in `COMMANDO_CONFIG`.
+      - The backend server reads `LIGHTNING_PUBKEY` & `LIGHTNING_RUNE` from the `LIGHTNING_VARS_FILE` file for this communication. 
+      - Values can either be set manually or script `entrypoint.sh` can be used to call `getinfo` and `createrune` methods and save values in `LIGHTNING_VARS_FILE`.
       - `entrypoint.sh` can only run for the locally installed lightning. If `cln-application` is running remotely then pubkey and 
       rune can be set manually.
       - Sample commando config should look like: