Ingress support added

modrisb · modrisb · commit 9a8d57e70707 · 2025-07-29T19:55:09.000+03:00
diff --git a/chirp2mqtt/CHANGELOG.md b/chirp2mqtt/CHANGELOG.md
@@ -1,8 +1,12 @@
 <!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
 
+## 1.1.144
+
+- Ingress support added
+
 ## 1.1.143
 
-- synchronized code with https://github.com/modrisb/chirp
+- Synchronized code with https://github.com/modrisb/chirp
 - Upgrade to ghcr.io/hassio-addons/base:18.0.3, CHIRPSTACK_VERSION: 4.13.0
 
 ## 1.1.142
diff --git a/chirp2mqtt/DOCS.md b/chirp2mqtt/DOCS.md
@@ -11,12 +11,12 @@ Follow these steps to get the add-on installed on your system:
 
 ## How to use
 
-Chirp2MQTT middleware add-on integrates ChirpStack server, Redis, PostgreSQL and small Python management component into single unit that could be installed on Home Assistant managed system with Mosquitto MQTT broker available at IP address core-mosquitto. Add-on allows to integrate LoraWAN devices into HA system via MQTT integration. Python management component registers all known and enabled in ChirpStack LoraWAN devices within MQTT, handles battery level set-up at service start, restores known sensor values and synchronize device list upon request. Device registration is handled via ChirpStack WWW interface and this may include updates in device Codec javascript code.
+Chirp2MQTT middleware add-on integrates ChirpStack server, Redis, PostgreSQL and small Python management component into single unit that could be installed on Home Assistant managed system with Mosquitto MQTT broker available at IP address core-mosquitto. Add-on allows to integrate LoRaWAN devices into HA system via MQTT integration. Python management component registers all known and enabled in ChirpStack LoRaWAN devices within MQTT, handles battery level set-up at service start, restores known sensor values and synchronize device list upon request. Device registration is handled via ChirpStack WWW interface and this may include updates in device Codec javascript code.
 Before add-on is installed you need to create Mosquitto MQTT broker user/password (remember that `homeassistant` or `addons` user names are reserved) with authority to subscribe/publish any topic. Recent version uses plain MQTT connection without any certificates on default port 1883.
 
 The add-on need to be configured before started, see **Configuration** section for details. Start add-on, initial start-up requires more time that successive startups. There is option to restore ChirpStack PostgreSQL database from backup file in HA /share/chirp2mqtt/chirp_db, on success backup file is renamed to chirp_db.restored .
 
-"Chirp2MQTT Bridge" device should show up as parent for all other LoraWAN devices managed by ChirpStack server. Bridge device exposes 'Reload devices' control to synchronize device list with server. Child devices are listed under "Connected devices". Child names are retrieved from ChirpStack server and must be managed from here. Integration uses LoRa deveui to identify device internally.
+"Chirp2MQTT Bridge" device should show up as parent for all other LoRaWAN devices managed by ChirpStack server. Bridge device exposes 'Reload devices' control to synchronize device list with server. Child devices are listed under "Connected devices". Child names are retrieved from ChirpStack server and must be managed from here. Integration uses LoRa deveui to identify device internally.
 
 Add-on on start-up searches for specific configuration files in HA directories /share/chirp2mqtt/etc/chirpstack and /share/chirp2mqtt/etc/chirpstack-gateway-bridge and replaces default configuration files with those customized. Default ChirpStack configuration files assumes on Semtech interface on port 1700.
 Python management component ensures that ChirpStack have at least 1 tenant and 1 application in its database by creating missing objects.
@@ -98,7 +98,7 @@ Default value: 'None' .
 
 ### Option: `import_actions`
 
-URL to git repository with LoraWAN device templates or 'none'. Repository is imported before ChirsStack starts. Parameter must be reset after importing to 'none', otherwise import will be started again on next add-on start-up. Chirp2MQTT automatically imports repository from HA directory /share/chirp2mqtt/lorawan-devices and marks import by creating file 'imported' to prevent continuous imports.
+URL to git repository with LoRaWAN device templates or 'none'. Repository is imported before ChirsStack starts. Parameter must be reset after importing to 'none', otherwise import will be started again on next add-on start-up. Chirp2MQTT automatically imports repository from HA directory /share/chirp2mqtt/lorawan-devices and marks import by creating file 'imported' to prevent continuous imports.
 
 Default(initial) value: 'https://github.com/brocaar/lorawan-devices' .
 
diff --git a/chirp2mqtt/Dockerfile b/chirp2mqtt/Dockerfile
@@ -18,6 +18,12 @@ RUN \
     apk --no-cache add python3 \
     && apk --no-cache add py3-pip \
     && pip3 install chirpstack-api paho-mqtt dukpy --break-system-packages \
+    && apk --no-cache add nodejs npm \
+    && npm install -g express \
+    && npm install -g http-proxy-middleware \
+    && sed -i 's/extend(/Object.assign(/g' /usr/local/lib/node_modules/http-proxy-middleware/node_modules/http-proxy/lib/http-proxy/index.js \
+    && sed -i 's/extend(/Object.assign(/g' /usr/local/lib/node_modules/http-proxy-middleware/node_modules/http-proxy/lib/http-proxy/common.js \
+    && npm install -g ipaddr.js \
     && apk --no-cache add git redis postgresql16 postgresql16-contrib su-exec \
     && sed -i 's/protected-mode yes/protected-mode no/' /etc/redis.conf \
     && sed -i 's/^\(bind .*\)$/# \1/' /etc/redis.conf \
diff --git a/chirp2mqtt/README.md b/chirp2mqtt/README.md
@@ -1,6 +1,6 @@
 # Home Assistant Add-on: ChirpStack add-on
 
-_Add-on to integrate ChirpStack LoraWAN server with HA via MQTT._
+_Add-on to integrate ChirpStack LoRaWAN server with HA via MQTT._
 
 ![Supports aarch64 Architecture][aarch64-shield]
 ![Supports amd64 Architecture][amd64-shield]
diff --git a/chirp2mqtt/config.yaml b/chirp2mqtt/config.yaml
@@ -1,22 +1,23 @@
 # https://developers.home-assistant.io/docs/add-ons/configuration#add-on-config
 name: Chirp2MQTT
-version: "1.1.143"
+version: "1.1.144"
 slug: chirp2mqtt
-description: HA add-on to incorporatex ChirpStack LoraWan devices into MQTT integration
+description: HA add-on to incorporate ChirpStack LoRaWAN devices into MQTT integration
 arch:
   - armhf
   - armv7
   - aarch64
   - amd64
+ingress: true
 url: "https://github.com/modrisb/chirpha"
 startup: application
-webui: http://[HOST]:[PORT:8080]
+webui: http://[HOST]:[PORT:8099]
 boot: auto
 ports:
-  8080/tcp: 8080
+  8099/tcp: 8099
   1700/udp: 1700
 ports_description:
-  8080/tcp: "ChirpStack server WEB UI port"
+  8099/tcp: "ChirpStack server WEB UI port"
   1700/udp: "Port to receive LoraWAN packets"
 homeassistant: "2024.3.1"
 map:
diff --git a/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/chirpstack/run b/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/chirpstack/run
@@ -105,7 +105,7 @@ if ! [ -f "$INITIALIZED" ]; then
     fi
 fi
 
-# import LoraWan device templates if repository found on HA /share
+# import LoRaWAN device templates if repository found on HA /share
 if [ -f "$EXTPATH/$DEVICES" ]; then
     if ! [ -f "$IMPORTED" ]; then
         chirpstack -c /etc/chirpstack import-legacy-lorawan-devices-repository -d "$EXTPATH/$DEVICES" >/dev/null
@@ -115,10 +115,10 @@ if [ -f "$EXTPATH/$DEVICES" ]; then
     fi
 fi
 
-# import LoraWan device templates from configured git repository - download and import
+# import LoRaWAN device templates from configured git repository - download and import
 IMPORT_ACTION=$(jq --raw-output '.import_actions // empty' $CONFILE)
 if ! [ "$IMPORT_ACTION" = "none" ]; then
-    echo Importing LoraWan devices from: $IMPORT_ACTION
+    echo Importing LoRaWAN devices from: $IMPORT_ACTION
     if [ -d "/data/temp" ]; then
         rm -r /data/temp
     fi
diff --git a/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/dependencies.d/base b/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/dependencies.d/base
diff --git a/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/run b/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/run
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+cd /usr/local/bin
+./ha-proxy.js
diff --git a/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/type b/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/ingress/type
@@ -0,0 +1 @@
+longrun
diff --git a/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/ingress b/chirp2mqtt/rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/ingress
diff --git a/chirp2mqtt/rootfs/usr/chirpha/const.py b/chirp2mqtt/rootfs/usr/chirpha/const.py
@@ -40,7 +40,7 @@
 BRIDGE = "Bridge"
 BRIDGE_STATE_ID = "state"
 BRIDGE_ENTITY_NAME = "Connection state"
-INTEGRATION_DEV_NAME = "ChirpStack LoraWan Integration"
+INTEGRATION_DEV_NAME = "ChirpStack LoRaWAN Integration"
 CONNECTIVITY_DEVICE_CLASS = "connectivity"
 BRIDGE_RESTART_ID = "restart"
 BRIDGE_RESTART_NAME = "Reload devices"
diff --git a/chirp2mqtt/rootfs/usr/local/bin/ha-proxy.js b/chirp2mqtt/rootfs/usr/local/bin/ha-proxy.js
@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+//
+//  https://github.com/jens-maus/RaspberryMatic/blob/e7c5bf51ae973861a5ecf4fe26619b6d33ac86d5/buildroot-external/overlay/base-raspmatic_oci/bin/ha-proxy.js
+// Copyright (c) 2021 Jens Maus <mail@jens-maus.de>
+//
+// Apache 2.0 License applies
+//
+//  Modifications to support HA ingress for ChirpStack
+//
+const express = require('/usr/local/lib/node_modules/express');
+const { createProxyMiddleware } = require('/usr/local/lib/node_modules/http-proxy-middleware');
+const ipaddr = require('/usr/local/lib/node_modules/ipaddr.js');
+const HM_HAPROXY_SRC="172.30.32.2/32";
+
+const apiProxy = createProxyMiddleware({
+  pathFilter:'/',
+  target: 'http://127.0.0.1:8080',
+  changeOrigin: true,
+  selfHandleResponse: true,
+  on: {
+      proxyRes (proxyRes, req, res) {
+
+        // modify Location: response header
+        if(typeof(proxyRes.headers.location) !== 'undefined') {
+          var redirect = proxyRes.headers.location;
+          redirect = req.headers['x-ingress-path'] + redirect;
+          proxyRes.headers.location = redirect;
+        }
+
+        const bodyChunks = [];
+        proxyRes.on('data', (chunk) => {
+          bodyChunks.push(chunk);
+        });
+        proxyRes.on('end', () => {
+          let body = Buffer.concat(bodyChunks);
+
+          // forwarding source status
+          res.status(proxyRes.statusCode);
+
+          // forwarding source headers
+          Object.keys(proxyRes.headers).forEach((key) => {
+            res.append(key, proxyRes.headers[key]);
+          });
+
+          // modifying textual response bodies
+          if (proxyRes.headers['content-type'] &&
+              (
+                proxyRes.headers['content-type'].includes('text/') ||
+                proxyRes.headers['content-type'].includes('application/javascript') ||
+                proxyRes.headers['content-type'].includes('application/grpc-web-text') ||
+                proxyRes.headers['content-type'].includes('application/json')
+              )
+              ) {
+
+            // if this a textual response body we make sure to prepend the ingress path
+            body = body.toString('latin1');
+
+            body = body.replace(/(?<=["'= \\])\/(assets|src|node_modules)(\\?\/)/g,
+                req.headers['x-ingress-path']+'/$1$2');
+
+            // add ingress path to client api calls to server
+            if(req.method=="GET" && req.path.indexOf("/assets/index")==0 && req.path.endsWith(".js")) {
+              body = body.replaceAll('this.hostname_+"/api.',
+                'this.hostname_+"'+req.headers['x-ingress-path']+'/api.');
+            }
+          
+            if(proxyRes.headers['transfer-encoding'] == 'chunked') {
+              res.end(new Buffer.from(body));
+            } else {
+              res.send(new Buffer.from(body));
+              res.end();
+            }
+          } else {
+            res.end(body);
+          }
+        });
+    }
+  },
+});
+
+const app = express();
+app.use((req, res, next) => {
+  //Get whitelisted range
+  let whitelisted_range = ipaddr.parseCIDR(HM_HAPROXY_SRC);
+  //Get source IP
+  let source_ip = ipaddr.parse(req.ip.split(':').pop());
+  //Check if source IP in whitelisted range
+  if(source_ip.match(whitelisted_range)) {
+      // allowed, forward to next middleware (proxy)
+    next();
+  } else {
+    // abort request with "403 Forbidden"
+    res.status(403).end();
+  }
+}, apiProxy);
+app.listen(8099);
diff --git a/chirp2mqtt/translations/en.yaml b/chirp2mqtt/translations/en.yaml
@@ -6,7 +6,7 @@ configuration:
   application_id:
     name: Application ID
     description: >-
-      Tenant's application ID to group LoraWAN devices for integration
+      Tenant's application ID to group LoRaWAN devices for integration
   mqtt_user:
     name: MQTT user name
     description: >-
@@ -44,17 +44,17 @@ configuration:
     description: >-
       Request ChirpStack database backup and/or restore to HA /share/chirp2mqtt folder
   import_actions:
-    name: Import LoraWAN device templates from git repository
+    name: Import LoRaWAN device templates from git repository
     description: >-
-      Import LoraWAN device templates from git repository into ChirpStack database
+      Import LoRaWAN device templates from git repository into ChirpStack database
   lora_region:
     name: Select Lora region
     description: >-
-      Select Lora region to use for ChirpStack LoraWan device communication
+      Select Lora region to use for ChirpStack LoRaWAN device communication
   chirpstack_secret:
     name: ChirpStack secret
     description: >-
       String used by ChirpStack to generate login and API tokens
 network:
   8080/tcp: ChirpStack server WEB UI port
-  1700/udp: Port to receive LoraWAN packets
+  1700/udp: Port to receive LoRaWAN packets
diff --git a/repository.yaml b/repository.yaml
@@ -1,4 +1,4 @@
 # https://developers.home-assistant.io/docs/add-ons/repository#repository-configuration
-name: ChirpStack LoraWan - Home Assistant integration add-on repository
+name: ChirpStack LoRaWAN - Home Assistant integration add-on repository
 url: 'https://github.com/modrisb/chirpha'
 maintainer: MB <modrisb@apollo.lv>
