From 9378901054bd95626897a0ab8d0836ad4604c8eb Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Thu, 17 Sep 2026 08:58:37 -0400 Subject: [PATCH] docs(install): what install_service.sh installs; verify script port; no sudo for --help install_service.sh installs and starts ledmatrix, ledmatrix-web and the update-verify units, not only ledmatrix.service (systemd/README.md, README.md). MIGRATION_GUIDE presented 'sudo install_service.sh --help' as a harmless check; it now shows --help without sudo and warns what a real run does. SSH_UNAVAILABLE_AFTER_INSTALL: verify_installation.sh checks the web interface on port 5000. Co-Authored-By: Claude Opus 5 --- README.md | 8 +++++--- docs/MIGRATION_GUIDE.md | 7 +++++-- docs/SSH_UNAVAILABLE_AFTER_INSTALL.md | 4 +++- systemd/README.md | 8 +++++--- 4 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a77ce1f..cca9503d 100644 --- a/README.md +++ b/README.md @@ -834,9 +834,11 @@ sudo ./scripts/install/install_service.sh The script will: - Detect your user account and home directory -- Install the service file with the correct paths -- Enable the service to start on boot -- Start the service immediately +- Install `ledmatrix.service` (display, runs as root), `ledmatrix-web.service` + (web interface, runs as your user) and the `ledmatrix-update-verify` units, + with the correct paths +- Enable them to start on boot +- Start them immediately ### Managing the Service diff --git a/docs/MIGRATION_GUIDE.md b/docs/MIGRATION_GUIDE.md index b64269b9..c6b17c94 100644 --- a/docs/MIGRATION_GUIDE.md +++ b/docs/MIGRATION_GUIDE.md @@ -59,9 +59,12 @@ sudo ./scripts/install/install_service.sh After updating your scripts, verify they still work: ```bash -# Test installation scripts (if needed) +# Check the installation scripts are at their new paths ls scripts/install/*.sh -sudo ./scripts/install/install_service.sh --help +./scripts/install/install_service.sh --help # prints usage only +# Note: running install_service.sh for real (with sudo, no --help) +# reinstalls, enables and restarts ledmatrix.service, ledmatrix-web.service +# and the update-verify units. # Test permission scripts ls scripts/fix_perms/*.sh diff --git a/docs/SSH_UNAVAILABLE_AFTER_INSTALL.md b/docs/SSH_UNAVAILABLE_AFTER_INSTALL.md index bc065eb1..4978b4c6 100644 --- a/docs/SSH_UNAVAILABLE_AFTER_INSTALL.md +++ b/docs/SSH_UNAVAILABLE_AFTER_INSTALL.md @@ -158,9 +158,11 @@ This script will check: - Python dependencies - Configuration files - File permissions -- Web interface availability +- Web interface availability (`ledmatrix-web` listening on port 5000) - Network connectivity +Once it passes, the web interface is at `http://:5000`. + ## Quick Reference Commands ```bash diff --git a/systemd/README.md b/systemd/README.md index a3a8cd5d..cdc65ec6 100644 --- a/systemd/README.md +++ b/systemd/README.md @@ -52,9 +52,11 @@ This directory contains systemd service unit files for LEDMatrix services. ## 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_service.sh` installs `ledmatrix.service`, `ledmatrix-web.service` + and the `ledmatrix-update-verify` service and path units, then enables and + starts them +- `install_web_service.sh` installs only `ledmatrix-web.service` and the + `ledmatrix-update-verify` 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)