BetterCorp/BetterFrame
1
0
Fork 0
mirror of https://github.com/BetterCorp/BetterFrame.git synced 2026-05-26 17:56:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
BetterFrame/deploy
History
Mitchell R b83782b8e0 feat: Node-RED custom nodes + dashboard entity type 
Node-RED nodes (nodered/):
- bf-config: shared server URL + admin API key
- bf-event-in: filter kiosk events by topic glob
- bf-layout-switch: POST display layout-switch
- bf-power: kiosk wake/standby
- bf-fan: kiosk fan control
- bf-cameras: query camera list
- Drag-droppable from Node-RED palette

Server:
- Admin Bearer API key auth on /admin/* (NodeRED can call admin API)
- GET /api/admin/cameras for bf-cameras node
- Dashboard entity type:
  - entities.type CHECK adds 'dashboard'
  - entities.dashboard_id column
  - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows
  - Bundle resolves dashboard entity → web cell at /dash/<id>
  - POST /admin/entities/sync-dashboards mirrors Node-RED tabs
  - EntitiesPage shows Dashboards section + Sync button
  - EntityEditPage for dashboard: read-only + "Open in Node-RED"
  - No create/delete from BF UI — managed in Node-RED
- sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-13 01:47:53 +02:00
..
angie fix(proxy): split Node-RED route surfaces 2026-05-11 10:44:45 +02:00
docker feat: Node-RED custom nodes + dashboard entity type 2026-05-13 01:47:53 +02:00
systemd fix(deploy): make Docker the service runtime 2026-05-11 10:08:33 +02:00
README.md fix(proxy): split Node-RED route surfaces 2026-05-11 10:44:45 +02:00

README.md

BetterFrame deployment

Recommended: Docker services + native kiosk

Run server, Angie/nginx, and Node-RED in Docker Compose. Only Angie publishes a host port. The BetterFrame backend ports and Node-RED are internal to the Docker network, which forces /nrdp/, /in/kiosk/, and admin traffic through the proxy auth rules.

cd /opt/betterframe
docker compose -f deploy/docker/docker-compose.yml up -d --build

Published:

  • 80 -> Angie/nginx public edge

Internal only:

  • 18080 -> admin service
  • 18081 -> kiosk API service
  • 18082 -> kiosk WebSocket service
  • 1880 -> Node-RED

Access first-run setup at:

http://<pi-ip>/setup

Node-RED editor is reachable only through:

http://<pi-ip>/nrdp/

The proxy has four route surfaces:

  • BetterFrame web/API: /, /setup, /admin/*, /auth/*, /static/*, /api/admin/*, /api/kiosk/*, /api/pair/*, /ws/kiosk
  • Kiosk-only Node-RED ingress: /in/kiosk/<node-red-path>
  • Kiosk-only Node-RED dashboards: /dash/*
  • Public Node-RED HTTP-in URLs: any otherwise-unmatched root path, plus /in/public/<node-red-path>

For example, a Node-RED http in node at /test1 is public at http://<pi-ip>/test1 and also available at http://<pi-ip>/in/public/test1. Kiosk-authenticated traffic to that same Node-RED path uses http://<pi-ip>/in/kiosk/test1.

Do not publish 18080, 18081, 18082, or 1880 on the host.

If migrating from an older native install, stop the old host daemons first:

sudo systemctl disable --now betterframe-server betterframe-nodered angie nginx 2>/dev/null || true

Kiosk

The kiosk still runs natively on the Pi because it needs Wayland/HDMI, GTK, GStreamer, display power control, and local hardware access.

sudo apt install -y libgtk-4-dev libgstreamer1.0-dev \
    libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-good \
    gstreamer1.0-plugins-bad gstreamer1.0-libav \
    gstreamer1.0-gtk4 libwebkitgtk-6.0-dev libssl-dev

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

cd /opt/betterframe/kiosk
cargo build --release
sudo install -Dm755 target/release/betterframe-kiosk /opt/betterframe/kiosk/betterframe-kiosk

mkdir -p ~/.config/systemd/user
cp /opt/betterframe/deploy/systemd/betterframe-kiosk.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable --now betterframe-kiosk

Kiosks should point at the proxy URL, not direct backend ports:

BETTERFRAME_SERVER=http://<pi-ip> /opt/betterframe/kiosk/betterframe-kiosk

Native server mode

Native server mode is for development only. Run it manually when debugging; do not install host daemons for BetterFrame server, Angie, or Node-RED in production. The Docker stack owns those services.