feat(apps): add Gashboard with native signing and viewer access

2026-10-06 06:42:25 +01:00
parent cedfbb2b07
commit 908e366006
100 changed files with 11072 additions and 0 deletions
@@ -0,0 +1,86 @@
+# Gashboard on Archipelago
+
+Install DATUM and configure its payout address, then install Gashboard. The app
+connects to `http://datum:7152` on `archy-net`, so recreating DATUM does not require
+copying a new container IP. The shared DATUM admin password is injected as a
+platform secret and never sent to the browser. This PR depends on the DATUM app
+package being merged and its build context being shipped.
+
+## Sign in and invite miners
+
+Use **Sign in with Nostr** inside Archipelago to choose a node identity through
+the native signer. A standalone visitor can use a browser extension or remote
+Nostr signer. No private key is entered into Gashboard.
+
+All user identities offered by Archipelago's signer are dashboard owners through
+`NODE_IDENTITY_PUBKEYS`; the appliance identity is excluded. Owners can open
+**Access**, paste another miner's `npub`, and add them as a viewer. Share the
+Gashboard URL on port 1337 over your intended node access route. Viewers can read
+the entire fleet and join dashboard chat; they cannot edit membership or configure
+DATUM. Access is independent of the miner's Stratum worker name. Signing with an
+unlisted identity is rejected even if that person mines through DATUM.
+
+Owners can remove a viewer in Access. Every authenticated request rechecks the
+list, so an already-issued JWT stops working immediately. Removing a viewer does
+not erase information or chat keys that their browser previously received.
+Membership lives in `/var/lib/archipelago/gashboard/access.json`; preserve this
+directory and the platform JWT secret across reinstall. Node owners are managed
+in Archipelago identities, not in Gashboard. Restart Gashboard after changing
+node identities to refresh owner access.
+
+The app gate uses `auth: open` because invited miners have Gashboard membership,
+not node administrator accounts. Gashboard still authenticates every data API.
+The gate supplies HTTPS and iframe header handling. A node administrator can
+enable the gate's extra login if only node users should reach the app.
+
+## Source and native signer
+
+`docker/gashboard` vendors the user-supplied Gashboard source at commit
+`68b606b` from `/home/yaya/Projects/gashboard`, with Archipelago integration and
+membership changes reviewed here. Its configured remote,
+`https://git.tx1138.com/lfg2025/gashboard.git`, was unavailable over TLS during
+preparation; upstream freshness has not been verified. Vendoring makes the build
+independent of that server. The original application declares the MIT license.
+
+The image bakes the canonical `neode-ui/public/nostr-provider.js`; the install
+hook refreshes its persisted copy from the node. Refresh the baked copy when
+updating the package. The server serves the provider uncached with
+`data-app-id="gashboard"` and `data-no-nip98`, preserving Gashboard's own NIP-98
+login. The service worker never caches the signer. Existing NIP-07 browser
+providers take precedence over the node provider. The CSP permits the native
+signer broker frame in standalone/companion launches.
+
+`/healthz` checks that the dashboard API is serving. DATUM connection failures are
+reported in the dashboard snapshot rather than disguised as a healthy mining
+fleet. Contribution history persists under `/data`; live miner connections and
+current hash rate recover through repeated DNS-based polling. Miner display names
+come from their worker names, and history uses the full Stratum username so
+multiple miners of the same model are not combined under a preset nickname.
+Use a distinct worker name for each miner. Old Umbrel history should not be
+copied blindly: its ledger used preset nicknames as identities.
+
+Before release, validate HTTP/HTTPS iframe launch, companion launch, native
+identity consent, invited-user login, revocation, DATUM address change/recovery,
+and install/start/stop/reinstall/reboot on a dedicated Archipelago test node.
+
+## Local validation (2026-10-06)
+
+API access-control and worker-identity tests, TypeScript checks, production builds,
+manifest validation and generated catalog drift checks pass. Both container images
+build and run with read-only roots, cap-drop ALL and no-new-privileges on Docker.
+Gashboard's digest-authenticated polling recovered after DATUM moved from
+172.22.0.2 to 172.22.0.4, without restarting or reconfiguring Gashboard, and after
+another DATUM restart with preserved settings.
+
+The access/login flow passed Chromium 153, Firefox 155 and WebKit 26.6, each at
+1440x900 and 390x844: native-provider NIP-98 through a simulated host frame,
+invalid-key feedback, invitation, reload persistence, removal, and layout fit.
+API tests also verify owner-only edits, rejected outsider login, persisted
+membership, owner protection, corruption refusal, and revoked JWT/SSE access.
+Browser scenarios and screenshots remain outside the repository in the shared
+browser-check workspace. These browser tests simulate the app gate and signer
+host; they do not establish real-node consent, HTTPS or Android acceptance.
+
+The generated storefront entries are review candidates. No signed catalog,
+registry image, deployment or release was published. Keep actual-node acceptance
+separate from these local results.
@@ -0,0 +1,89 @@
+app:
+  id: gashboard
+  name: Gashboard
+  version: 0.2.0
+  description: A playful mining dashboard for your DATUM fleet, with live hashrates, share history, lottery odds, chat and a Nostr viewer access list.
+  upstream:
+    kind: internal
+  container:
+    build:
+      context: /opt/archipelago/docker/gashboard
+      dockerfile: Dockerfile
+      tag: localhost/archipelago-gashboard:0.2.0
+    network: archy-net
+    data_uid: "1000:1000"
+    derived_env:
+      - key: NOSTR_OWNER_PUBKEYS
+        template: "{{NODE_IDENTITY_PUBKEYS}}"
+    generated_secrets:
+      - name: gashboard-jwt-secret
+        kind: hex32
+    secret_env:
+      - key: JWT_SECRET
+        secret_file: gashboard-jwt-secret
+      - key: DATUM_ADMIN_PASSWORD
+        secret_file: datum-admin-password
+  install_prerequisites: [datum]
+  dependencies:
+    - app_id: datum
+    - storage: 1Gi
+  resources:
+    cpu_limit: 1
+    memory_limit: 512Mi
+    disk_limit: 1Gi
+  security:
+    capabilities: []
+    readonly_root: true
+    no_new_privileges: true
+    network_policy: isolated
+  ports:
+    - host: 1337
+      container: 1337
+      protocol: tcp
+      bind: 127.0.0.1
+      auth: open
+      auth_rationale: Gashboard verifies NIP-98 signatures and an owner-managed Nostr access list before issuing sessions. Every data route rechecks membership; invited miners must not need a node administrator login.
+  volumes:
+    - type: bind
+      source: /var/lib/archipelago/gashboard
+      target: /data
+      options: [rw]
+    - type: tmpfs
+      target: /tmp
+      tmpfs_options: rw,noexec,nosuid,size=16m
+  environment:
+    - NODE_ENV=production
+    - PORT=1337
+    - DATUM_URL=http://datum:7152
+    - DATUM_ADMIN_USER=admin
+    - CONTRIBUTION_LEDGER_PATH=/data/contribution-ledger.json
+    - ACCESS_LIST_PATH=/data/access.json
+    - ARCHIPELAGO_PROVIDER_PATH=/data/nostr-provider.js
+    - MEMPOOL_API_URL=https://mempool.space/api
+  hooks:
+    post_install:
+      - copy_from_host:
+          src: web-ui/nostr-provider.js
+          dest: /data/nostr-provider.js
+      - exec: ["test", "-s", "/data/nostr-provider.js"]
+  health_check:
+    type: http
+    endpoint: http://localhost:1337
+    path: /healthz
+    interval: 30s
+    timeout: 5s
+    retries: 3
+  interfaces:
+    main:
+      name: Mining dashboard
+      type: ui
+      port: 1337
+      protocol: http
+      path: /
+  metadata:
+    icon: /assets/img/app-icons/gashboard.svg
+    category: bitcoin
+    tier: optional
+    repo: https://gitworkshop.dev/npub1w3sqdkrhn0gyuvsex32effzgnfpyde6qrrc4u467flg5e9txh4wsfn5vjg/relay.ngit.dev/archy
+    launch:
+      open_in_new_tab: false