mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 22:35:08 +00:00
ChuckandClaude Opus 5
869e36fb2f
* feat(web): weekly automatic updates with health check and rollback A General-tab toggle (off by default) checks for and installs LEDMatrix and plugin updates once a week, overnight in the configured timezone. - Pre-update checks skip (and report) instead of forcing: local edits or commits, merge/live rebase, no upstream, low disk, missing health check, or a version that was already rolled back. An abandoned rebase (HEAD back on a branch) is cleared, since it would otherwise block every pull. - The pull reuses the Update Code path (now perform_core_update(), which reports dependency install failures as data). - ledmatrix-update-verify.service, started via a .path unit from a request file, restarts the services from its own cgroup, requires them to come up and stay up, and otherwise resets to the previous commit and reinstalls the previous requirements. It runs a copy of the checker taken before the pull. - No SSH needed: switching the toggle on restarts the display service, which (as root) installs the two units from the repo templates for the web user. first_time_install.sh installs them too and takes --enable-auto-update / LEDMATRIX_AUTO_UPDATE (passed through by one-shot-install.sh). - Plugins update after the code passes its check; failures, blocks and rollbacks raise an Overview banner and show under the toggle. Tested end to end on a Pi: web-UI setup, a good update, a broken web service and a broken display (both rolled back), a blocked local edit, and an abandoned rebase found on the device. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * chore(auto-update): address static-analysis findings - Replace the subprocess.CompletedProcess the verifier fabricated for a command that could not start with a plain namedtuple; nothing is executed there, but the scanner flags any CompletedProcess built from variables. - Mark the subprocess imports with the repo's standard B404 annotation (all calls are list-form argv, no shell). - Mark the rollback-failed message as not SQL (B608 matched its wording). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(auto-update): CI failures on Linux - Keep the setup result when chown fails. CI runs as a non-root user, where chown to the web user raises; that discarded the result file, so the General tab would never learn whether setup worked. Regression test added. - Register the two new /api/v3/system/auto-update routes in the URL map snapshot. - Use utility classes app.css defines (space-y-1, hover:text-red-600). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(auto-update): address review feedback - Health check: a failed restart command no longer lets the check run against the still-running old process; it counts as a failure (and after a rollback, as a failed rollback). An unreadable restart count is never treated as stable, since a crash loop looks healthy between attempts. - Installer writes the auto_update setting to a temp file and swaps it in, keeping mode and owner, so a running config watcher never reads a truncated config.json. - Verify unit quotes its command-line paths (install folders with spaces); setup refuses folder names systemd would reinterpret (%, quotes, backslashes, control characters) and says so on the General tab. - The auto-update status route no longer returns exception text. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(auto-update): keep error detail in the status route's 500 test_web_error_detail requires every 5xx handler to log the traceback and return describe_exception(e), which redacts credentials, so failures are diagnosable from the web UI. Dropping it for CodeQL broke that policy. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(auto-update): dismiss route rejects non-object JSON with 400 A JSON array or scalar body made `.get('alert_id')` raise, returning 500. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(auto-update): let the app-wide handler answer status-route errors CodeQL (py/stack-trace-exposure, #709) flagged the route's own except, which returned describe_exception(e). web_interface/app.py's error handler already logs the traceback and returns the same redacted detail for any unhandled exception, so the local copy is removed: same response, no new exception-to-response flow, and test_web_error_detail's policy still holds. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
108 lines
4.0 KiB
Markdown
108 lines
4.0 KiB
Markdown
# Systemd Service Files
|
|
|
|
This directory contains systemd service unit files for LEDMatrix services.
|
|
|
|
## Service Files
|
|
|
|
- **`ledmatrix.service`** - Main LED Matrix display service
|
|
- Runs the display controller (`run.py`)
|
|
- Starts automatically on boot
|
|
- Runs as root for hardware access
|
|
|
|
- **`ledmatrix-web.service`** - Web interface service
|
|
- Runs the web interface conditionally based on config
|
|
- Starts automatically on boot if `web_display_autostart` is enabled
|
|
- Uses `scripts/utils/start_web_conditionally.py`
|
|
|
|
- **`ledmatrix-update-verify.service`** / **`.path`** - Automatic update health check and rollback
|
|
- The path unit starts the service when the web interface creates
|
|
`data/auto_update_verify.request` after a weekly automatic update
|
|
- Installed by the installers, or by the display service when automatic
|
|
updates are turned on in the web UI (`src/auto_update_setup.py`)
|
|
- Restarts the services, checks they stay up, and otherwise resets to the
|
|
previous commit and its dependencies
|
|
- Runs `data/auto_update_verifier.py`, a copy of
|
|
`scripts/utils/auto_update_verify.py` taken before the update
|
|
|
|
- **`ledmatrix-wifi-monitor.service`** - WiFi monitor daemon service
|
|
- Monitors WiFi/Ethernet connectivity
|
|
- Automatically enables/disables access point mode
|
|
- Uses `scripts/utils/wifi_monitor_daemon.py`
|
|
|
|
- **`ledmatrix-dns-fix.service`** - DNS single-request fix (optional)
|
|
- Re-applies `options single-request` to the resolver on every boot,
|
|
because whatever manages `resolv.conf` regenerates it and drops the
|
|
option again
|
|
- Works around glibc's parallel A/AAAA lookup stalling ~5s per name on
|
|
routers that answer only the A query, which makes any plugin calling an
|
|
external API slow or (for Starlark apps, which have a render timeout)
|
|
fail outright
|
|
- Uses `scripts/utils/apply_dns_single_request.sh`
|
|
- Install only if external API calls are timing out; it is not part of a
|
|
normal install
|
|
|
|
- **`ledmatrix-mqtt-bridge.service`** - Home Assistant MQTT bridge (optional)
|
|
- Exposes the display to Home Assistant over MQTT Discovery: force a mode,
|
|
stop on-demand, toggle power, set brightness
|
|
- Uses `integrations/mqtt_bridge/ledmatrix_mqtt_bridge.py`, which drives the
|
|
web API rather than the display directly
|
|
- Needs `integrations/mqtt_bridge/bridge_config.json`; see that directory's
|
|
README
|
|
|
|
## Installation
|
|
|
|
These service files are installed by the installation scripts in `scripts/install/`:
|
|
- `install_service.sh` installs `ledmatrix.service`
|
|
- `install_web_service.sh` installs `ledmatrix-web.service` and the
|
|
`ledmatrix-update-verify` service and path units
|
|
- `install_wifi_monitor.sh` installs `ledmatrix-wifi-monitor.service`
|
|
- `install_dns_fix.sh` installs `ledmatrix-dns-fix.service` (opt-in, not run
|
|
by the normal installer)
|
|
- `install_mqtt_bridge.sh` installs `ledmatrix-mqtt-bridge.service` (opt-in)
|
|
|
|
## Manual Installation
|
|
|
|
> **Important:** the unit files in this directory contain
|
|
> `__PROJECT_ROOT_DIR__` placeholders that the install scripts replace
|
|
> with the actual project directory at install time. Do **not** copy
|
|
> them directly to `/etc/systemd/system/` — the service will fail to
|
|
> start with `WorkingDirectory=__PROJECT_ROOT_DIR__` errors.
|
|
>
|
|
> Always install via the helper script:
|
|
>
|
|
> ```bash
|
|
> sudo ./scripts/install/install_service.sh
|
|
> ```
|
|
>
|
|
> If you really need to do it by hand, substitute the placeholder
|
|
> first:
|
|
>
|
|
> ```bash
|
|
> PROJECT_ROOT="$(pwd)"
|
|
> sed "s|__PROJECT_ROOT_DIR__|$PROJECT_ROOT|g" systemd/ledmatrix.service \
|
|
> | sudo tee /etc/systemd/system/ledmatrix.service > /dev/null
|
|
> sudo systemctl daemon-reload
|
|
> sudo systemctl enable ledmatrix.service
|
|
> sudo systemctl start ledmatrix.service
|
|
> ```
|
|
|
|
## Service Management
|
|
|
|
```bash
|
|
# Check status
|
|
sudo systemctl status ledmatrix.service
|
|
|
|
# Start/stop/restart
|
|
sudo systemctl start ledmatrix.service
|
|
sudo systemctl stop ledmatrix.service
|
|
sudo systemctl restart ledmatrix.service
|
|
|
|
# Enable/disable autostart
|
|
sudo systemctl enable ledmatrix.service
|
|
sudo systemctl disable ledmatrix.service
|
|
|
|
# View logs
|
|
journalctl -u ledmatrix.service -f
|
|
```
|
|
|