mirror of https://github.com/BetterCorp/BetterFrame.git synced 2026-05-26 19:06:34 +00:00

History

Mitchell R d5bd64d05c feat(deploy): self-update + auto-reboot on boot-file changes Two ergonomics fixes so one invocation does the right thing: 1. After git pull, re-exec the script if the installer itself changed in the pull. Previously you'd need a second run to pick up new logic. BF_REEXEC=1 guard prevents loops. 2. Track REBOOT_NEEDED when cmdline.txt / config.txt get edited or /var/run/reboot-required appears (apt kernel/libc update). At end of run, auto-reboot after a 10s cancellable window. Override with BF_NO_REBOOT=1.		2026-05-13 12:58:20 +02:00
..
angie	fix(proxy): split Node-RED route surfaces	2026-05-11 10:44:45 +02:00
docker	feat(nodered): auto-provision bf-server-config on boot	2026-05-13 03:09:25 +02:00
pam.d	feat(deploy): Pi kiosk bring-up via cage + low-priv bfkiosk user	2026-05-13 03:11:06 +02:00
plymouth/betterframe	feat(deploy): BetterFrame plymouth boot splash	2026-05-13 03:21:37 +02:00
scripts	feat(deploy): self-update + auto-reboot on boot-file changes	2026-05-13 12:58:20 +02:00
systemd	fix(kiosk): strip caps so WebKit's bwrap sandbox can start	2026-05-13 12:53:31 +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.