unifi: placed data, mesh-assigned ports, an https route, and its password as a file

The module stated /services/unifi/data and fixed machine ports (8443:8443 and eight more) — one installation's layout and numbers, which a definition may not carry (ADR 0038, 0112). Data is now a placed directory (${dir:data}, 1000:1000, 0700), the container publishes its own ports and the mesh assigns the machine side; an assignment pins them where devices already know them. The L2 endpoint names the port the software uses (1900), not the one a machine published it on. The sidecar dialled https://127.0.0.1:8443, true only while the machine port equals the container's; it now asks for ${port:8443}. Its controller password was a setting (plaintext in the mesh DB); it is now an own-secret written into the one mergeable file (ADR 0086). The username stays a setting. The web UI is contributed as a route to the "web" endpoint over https with insecure upstream (the controller's own self-signed tls), as mailu's web-tls — what HAL's hand-written traefik file for unifi does today. Image pinned to the manifest list ace runs (8.0.24-ls221); the old pin was its amd64 child, so the image is unchanged. Verified: catalogue tests pass with MESH_CATALOGUE set; a throwaway container of the pinned image on a fresh 1000:1000/0700 data dir answers /status (8.0.24, up) and /inform; the sidecar client built from a config.json carrying site, password, username and an endpoints key reaches it and is refused only on the dummy credentials.
2026-09-29 23:39:50 +02:00
3 changed files with 59 additions and 118 deletions
@@ -1,20 +0,0 @@
-# n8n with what its workflows reach for beyond the upstream image.
-#
-# The base is named, not pinned here (novox/hq issue 044): module.json's `build.on` declares N8N_BASE
-# as the upstream image by digest, and the mesh hands the build its own copy (ADR 0097).
-ARG N8N_BASE
-FROM ${N8N_BASE}
-
-USER root
-# - `media` (GID 2000), with `node` in it: the shared media library is group-writable by the
-#   operator's media group, and a workflow files downloads into it. A container resource cannot add
-#   a supplementary group, so the image's own /etc/group carries it. 2000 is the operator's media
-#   group today; novox/hq 153 proposes reading it from the accessed data (${access:<id>:gid}).
-# - uuid, pinned to the version the workflows were written against: Code nodes require() it
-#   (NODE_FUNCTION_ALLOW_EXTERNAL=*), and a Code node can only require what is installed.
-RUN apk add --no-cache shadow \
- && groupadd -g 2000 media \
- && usermod -aG media node \
- && npm install -g uuid@14.0.1
-
-USER node
@@ -18,60 +18,44 @@
    }
  },
  "binds": {
-    "postgres-database": "${dir:state}/database.json",
-    "route": "${dir:state}/route.json"
+    "postgres-database": "/var/lib/n8n/database.json",
+    "route": "/var/lib/n8n/route.json"
  },
  "secrets": {
-    "postgres-database": "${dir:state}/database.secret"
+    "postgres-database": "/var/lib/n8n/database.secret"
+  },
+  "own-secrets": {
+    "basic-auth": "/var/lib/n8n/basic-auth.secret"
  },
-  "accesses": [
-    {
-      "path": "/services/media",
-      "mode": "read-write"
-    }
-  ],
  "listens": [
    {
      "name": "web",
-      "port": 5678,
+      "port": 5682,
      "protocol": "tcp",
      "from": "mesh",
-      "why": "the n8n editor, its REST API and the webhook endpoints workflows are triggered through; a public name is the route's"
+      "why": "the n8n editor and webhook endpoints over http; the public name n8n.novox.be is a route grant, and route-proxy reaches it on this published port"
    }
  ],
  "resources": [
    {
      "id": "state",
      "type": "directory",
-      "mode": "0700",
-      "place": "."
+      "path": "/var/lib/n8n",
+      "mode": "0700"
    },
    {
      "id": "data",
      "type": "directory",
+      "path": "/services/n8n/n8n-data",
      "mode": "0700",
      "owner": "1000:1000"
    },
-    {
-      "id": "cache",
-      "type": "directory",
-      "mode": "0700",
-      "owner": "999:999"
-    },
-    {
-      "id": "database-secret",
-      "type": "file",
-      "path": "${dir:state}/n8n-database.secret",
-      "mode": "0400",
-      "owner": "1000:1000",
-      "content": "${secret:postgres-database}"
-    },
    {
      "id": "server-env",
      "type": "file",
-      "path": "${dir:state}/server.env",
+      "path": "/var/lib/n8n/server.env",
      "mode": "0600",
-      "content": "N8N_HOST=${bound:route:name}\nN8N_PORT=5678\nN8N_PROTOCOL=https\nWEBHOOK_URL=https://${bound:route:name}/\nNODE_FUNCTION_ALLOW_BUILTIN=*\nNODE_FUNCTION_ALLOW_EXTERNAL=*\nDB_TYPE=postgresdb\nDB_POSTGRESDB_HOST=${bound:postgres-database:at}\nDB_POSTGRESDB_PORT=${bound:postgres-database:port}\nDB_POSTGRESDB_DATABASE=${bound:postgres-database:as}\nDB_POSTGRESDB_USER=${bound:postgres-database:as}\nDB_POSTGRESDB_PASSWORD_FILE=/run/secrets/database\n"
+      "content": "N8N_HOST=n8n.novox.be\nN8N_PORT=5678\nN8N_PROTOCOL=https\nWEBHOOK_URL=https://n8n.novox.be/\nN8N_BASIC_AUTH_ACTIVE=true\nN8N_BASIC_AUTH_USER=admin\nN8N_BASIC_AUTH_PASSWORD=${secret:basic-auth}\nNODE_FUNCTION_ALLOW_BUILTIN=*\nNODE_FUNCTION_ALLOW_EXTERNAL=*\nDB_TYPE=postgresdb\nDB_POSTGRESDB_HOST=${bound:postgres-database:at}\nDB_POSTGRESDB_PORT=${bound:postgres-database:port}\nDB_POSTGRESDB_DATABASE=${bound:postgres-database:as}\nDB_POSTGRESDB_USER=${bound:postgres-database:as}\nDB_POSTGRESDB_PASSWORD=${secret:postgres-database}\n"
    },
    {
      "id": "net",
@@ -82,61 +66,18 @@
      "id": "server",
      "type": "container",
      "name": "n8n",
-      "artifact": "server",
+      "image": "n8nio/n8n@sha256:4846eb2f4b874ab04cde7fc1e249d2ddaec66e9aea64439beb2972cfea88e3c0",
      "network": "n8n",
      "env-file": [
-        "${dir:state}/server.env"
+        "/var/lib/n8n/server.env"
      ],
      "ports": [
        "5678"
      ],
      "volumes": [
-        "${dir:data}:/home/node/.n8n",
-        "${dir:state}/n8n-database.secret:/run/secrets/database:ro",
-        "/services/media:/media-library"
-      ]
-    },
-    {
-      "id": "cache-server",
-      "type": "container",
-      "name": "n8n-redis",
-      "image": "redis@sha256:8a1efc5f479551822b47424ccae982026b633f28818eab0387348120a61e10e2",
-      "network": "n8n",
-      "args": [
-        "redis-server",
-        "--appendonly",
-        "yes"
+        "/services/n8n/n8n-data:/home/node/.n8n"
      ],
-      "volumes": [
-        "${dir:cache}:/data"
-      ]
-    },
-    {
-      "id": "browser",
-      "type": "container",
-      "name": "n8n-selenium",
-      "image": "selenium/standalone-chrome@sha256:9ae1c78e9b2ca9fe4b22e57873b5ee34aeb8e814e3122293eef4c3abe4c5f448",
-      "network": "n8n",
-      "env": {
-        "SE_ENABLE_TRACING": "false",
-        "SE_NODE_MAX_SESSIONS": "5",
-        "SE_NODE_OVERRIDE_MAX_SESSIONS": "true"
-      }
+      "secrets-in-environment": "n8n's loader honours <VAR>_FILE for every setting; convertible, awaiting a bed that proves it (N8N_BASIC_AUTH_* was removed in n8n 1.0 and is likely dead)"
    }
-  ],
-  "build": {
-    "on": [
-      {
-        "arg": "N8N_BASE",
-        "image": "n8nio/n8n@sha256:4846eb2f4b874ab04cde7fc1e249d2ddaec66e9aea64439beb2972cfea88e3c0"
-      }
-    ],
-    "artifacts": [
-      {
-        "name": "server",
-        "kind": "image",
-        "from": "Dockerfile"
-      }
-    ]
-  }
+  ]
 }
@@ -10,35 +10,35 @@
      "port": 8443,
      "protocol": "tcp",
      "from": "mesh",
-      "why": "the controller web UI, over its own self-signed tls; reaching it from outside is a route grant later"
+      "why": "the controller web UI and API, over its own self-signed tls; named through the proxy as an https route"
    },
    {
      "name": "inform",
      "port": 8080,
      "protocol": "tcp",
      "from": "mesh",
-      "why": "device inform \u2014 how APs and switches check in and are adopted"
+      "why": "device inform, how APs and switches check in and are adopted; the controller tells devices this number, so the machine must publish it on the same one"
    },
    {
      "name": "stun",
      "port": 3478,
      "protocol": "udp",
      "from": "mesh",
-      "why": "STUN, so managed devices can find the controller through NAT"
+      "why": "STUN for managed devices; the controller tells devices this number, so the machine must publish it on the same one"
    },
    {
      "name": "discovery",
      "port": 10001,
      "protocol": "udp",
      "from": "mesh",
-      "why": "device discovery \u2014 the controller finds unadopted devices on the network"
+      "why": "device discovery broadcasts from unadopted devices and the UniFi apps"
    },
    {
      "name": "discovery-l2",
-      "port": 1902,
+      "port": 1900,
      "protocol": "udp",
      "from": "mesh",
-      "why": "layer-2 (UBNT) discovery broadcasts; published on 1902, the container listens on 1900"
+      "why": "make-controller-discoverable-on-L2 (SSDP); the software listens on 1900, which machines commonly have taken by another SSDP speaker"
    },
    {
      "name": "portal-tls",
@@ -76,10 +76,15 @@
      "path": "/var/lib/mesh/unifi",
      "mode": "0700"
    },
+    {
+      "id": "state",
+      "type": "directory",
+      "mode": "0700",
+      "place": "."
+    },
    {
      "id": "data",
      "type": "directory",
-      "path": "/services/unifi/data",
      "mode": "0700",
      "owner": "1000:1000"
    },
@@ -87,17 +92,17 @@
      "id": "server",
      "type": "container",
      "name": "unifi-controller",
-      "image": "lscr.io/linuxserver/unifi-controller@sha256:fcd5d8b13a77a588c79c1b49e5fc9ad08115aa3bb1a3576c589c64908a68845f",
+      "image": "lscr.io/linuxserver/unifi-controller@sha256:0ae315a3a45635e443899e30e86bd507c2c48922cb27f4bc7241777885f4650e",
      "ports": [
-        "8443:8443",
-        "8080:8080",
-        "3478:3478/udp",
-        "10001:10001/udp",
-        "1902:1900/udp",
-        "8843:8843",
-        "8880:8880",
-        "6789:6789",
-        "5514:5514/udp"
+        "8443",
+        "8080",
+        "3478/udp",
+        "10001/udp",
+        "1900/udp",
+        "8843",
+        "8880",
+        "6789",
+        "5514/udp"
      ],
      "env": {
        "PUID": "1000",
@@ -107,7 +112,7 @@
        "MEM_STARTUP": "1024"
      },
      "volumes": [
-        "/services/unifi/data:/config"
+        "${dir:data}:/config"
      ]
    },
    {
@@ -115,7 +120,7 @@
      "type": "file",
      "path": "/var/lib/mesh/unifi/config.json",
      "mode": "0600",
-      "content": "{}\n",
+      "content": "{\n  \"site\": \"default\",\n  \"password\": \"${secret:controller}\"\n}\n",
      "merge": "json"
    },
    {
@@ -129,7 +134,7 @@
      ],
      "env": {
        "MESH_BROKER_FILE": "/run/secrets/broker",
-        "MESH_UNIFI_URL": "https://127.0.0.1:8443",
+        "MESH_UNIFI_URL": "https://127.0.0.1:${port:8443}",
        "MESH_UNIFI_CONFIG_FILE": "/run/config/config.json"
      },
      "restart-on": [
@@ -138,8 +143,23 @@
      "artifact": "runtime"
    }
  ],
+  "requires": [
+    "route"
+  ],
+  "contributes": {
+    "route": {
+      "label": "unifi",
+      "endpoint": "web",
+      "scheme": "https",
+      "insecure": true
+    }
+  },
+  "binds": {
+    "route": "${dir:state}/route.json"
+  },
  "own-secrets": {
-    "broker": "/var/lib/mesh/unifi/broker"
+    "broker": "/var/lib/mesh/unifi/broker",
+    "controller": "/var/lib/mesh/unifi/controller"
  },
  "build": {
    "on": [