mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-10-17 20:39:13 +00:00

Files

T

Claude a561a7500a fix(install): escape sed replacements, use mktemp, and make render failures fatal

Address CodeRabbit findings on install_service.sh, install_web_service.sh and
install_wifi_monitor.sh:

- Values interpolated into each script's sed expression (project root path,
  username) were not escaped, so a value containing &, \ or the | delimiter
  would corrupt the rendered systemd unit. Add a shared
  sed_escape_replacement() helper in the new scripts/install/lib_systemd_render.sh
  (sourced by all three scripts) and apply it to every sed replacement.
- install_service.sh rendered the main and web units to the predictable path
  /tmp/ledmatrix.service.tmp before installing them -- a symlink/TOCTOU race
  (CWE-377). Use mktemp for both, with a trap to clean up on exit.
- install_service.sh treated a missing template as a mere warning and then
  checked only whether a unit already existed at the destination before
  enabling/starting it, so a render failure could silently fall back to
  enabling a stale, previously-installed unit. Both unit blocks now exit
  non-zero on a missing template or a failed render.

Also rename the ambiguous loop variable `l` to `line` in
test/test_systemd_unit_drift.py (Ruff E741); ruff isn't wired into any CI
workflow in this repo today, so this isn't currently CI-blocking, but the
rename is trivial and correct regardless.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01S3bPMESe2TfrGvbs1ef9c5

2026-09-11 02:22:37 +00:00

configure_web_sudo.sh

fix(install): tag the secondary installer's journalctl grants too (#491 )

2026-08-21 14:28:23 -04:00

configure_wifi_permissions.sh

harden: cap malloc arenas, warn on unit drift, and grant the portal's sudo commands (#476 )

2026-08-21 14:29:45 -04:00

debug_install.sh

Feature/one shot installer (#178 )

2026-01-11 16:38:55 -05:00

install_dns_fix.sh

feat(starlark,on-demand): the third-party fixes worth taking, plus a Home Assistant MQTT bridge (#538 )

2026-09-08 08:34:52 -04:00

install_mqtt_bridge.sh

feat(starlark,on-demand): the third-party fixes worth taking, plus a Home Assistant MQTT bridge (#538 )

2026-09-08 08:34:52 -04:00

install_service.sh

fix(install): escape sed replacements, use mktemp, and make render failures fatal

2026-09-11 02:22:37 +00:00

install_web_service.sh

fix(install): escape sed replacements, use mktemp, and make render failures fatal

2026-09-11 02:22:37 +00:00

install_wifi_monitor.sh

fix(install): escape sed replacements, use mktemp, and make render failures fatal

2026-09-11 02:22:37 +00:00

lib_lowmem.sh

fix(install): survive the rgbmatrix build on low-memory Pis (#430 )

2026-08-03 15:21:18 -04:00

lib_systemd_render.sh

fix(install): escape sed replacements, use mktemp, and make render failures fatal

2026-09-11 02:22:37 +00:00

migrate_config.sh

Plugins (#145 )

2025-12-27 14:15:49 -05:00

one-shot-install.sh

fix(install): survive the rgbmatrix build on low-memory Pis (#430 )

2026-08-03 15:21:18 -04:00

README.md

docs: refresh and correct stale documentation across repo (#306 )

2026-04-07 21:04:25 -04:00

setup_cache.sh

Plugins (#145 )

2025-12-27 14:15:49 -05:00

README.md

Installation Scripts

This directory contains scripts for installing and configuring the LEDMatrix system.

Scripts

one-shot-install.sh - Single-command installer; clones the repo, checks prerequisites, then runs first_time_install.sh. Invoked via curl ... | bash from the project root README.
install_service.sh - Installs the main LED Matrix display service (systemd)
install_web_service.sh - Installs the web interface service (systemd)
install_wifi_monitor.sh - Installs the WiFi monitor daemon service
setup_cache.sh - Sets up persistent cache directory with proper permissions
configure_web_sudo.sh - Configures passwordless sudo access for web interface actions
configure_wifi_permissions.sh - Grants the ledmatrix user the WiFi management permissions needed by the web interface and the WiFi monitor service
migrate_config.sh - Migrates configuration files to new formats (if needed)
debug_install.sh - Diagnostic helper used when an install fails; collects environment info and recent logs

Usage

These scripts are typically called by first_time_install.sh in the project root (which itself is invoked by one-shot-install.sh), but can also be run individually if needed.

Note: Most installation scripts require sudo privileges to install systemd services and configure system settings.