rick/LEDMatrix
1
0
Fork 0
mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-10-13 10:36:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(install): what install_service.sh installs; verify script port; no sudo for --help

Browse Source 
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 <noreply@anthropic.com>
This commit is contained in:
Chuck
2026-09-17 08:58:37 -04:00
co-authored by Claude Opus 5
parent c3465c35f5
commit 9378901054
4 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -3
View File
@@ -834,9 +834,11 @@ sudo ./scripts/install/install_service.sh
The script will: The script will:
- Detect your user account and home directory - Detect your user account and home directory
- Install the service file with the correct paths - Install `ledmatrix.service` (display, runs as root), `ledmatrix-web.service`
- Enable the service to start on boot (web interface, runs as your user) and the `ledmatrix-update-verify` units,
- Start the service immediately with the correct paths
- Enable them to start on boot
- Start them immediately
### Managing the Service ### Managing the Service
docs/MIGRATION_GUIDE.md
+5 -2
View File
@@ -59,9 +59,12 @@ sudo ./scripts/install/install_service.sh
After updating your scripts, verify they still work: After updating your scripts, verify they still work:
```bash ```bash
# Test installation scripts (if needed) # Check the installation scripts are at their new paths
ls scripts/install/*.sh 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 # Test permission scripts
ls scripts/fix_perms/*.sh ls scripts/fix_perms/*.sh
docs/SSH_UNAVAILABLE_AFTER_INSTALL.md
+3 -1
View File
@@ -158,9 +158,11 @@ This script will check:
- Python dependencies - Python dependencies
- Configuration files - Configuration files
- File permissions - File permissions
- Web interface availability - Web interface availability (`ledmatrix-web` listening on port 5000)
- Network connectivity - Network connectivity
Once it passes, the web interface is at `http://<pi-ip>:5000`.
## Quick Reference Commands ## Quick Reference Commands
```bash ```bash
systemd/README.md
+5 -3
View File
@@ -52,9 +52,11 @@ This directory contains systemd service unit files for LEDMatrix services.
## Installation ## Installation
These service files are installed by the installation scripts in `scripts/install/`: These service files are installed by the installation scripts in `scripts/install/`:
- `install_service.sh` installs `ledmatrix.service` - `install_service.sh` installs `ledmatrix.service`, `ledmatrix-web.service`
- `install_web_service.sh` installs `ledmatrix-web.service` and the and the `ledmatrix-update-verify` service and path units, then enables and
`ledmatrix-update-verify` service and path units 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_wifi_monitor.sh` installs `ledmatrix-wifi-monitor.service`
- `install_dns_fix.sh` installs `ledmatrix-dns-fix.service` (opt-in, not run - `install_dns_fix.sh` installs `ledmatrix-dns-fix.service` (opt-in, not run
by the normal installer) by the normal installer)