mirror of https://github.com/ChuckBuilds/LEDMatrix.git synced 2026-04-10 21:03:01 +00:00

Files

Chuck 2f3433cebc docs: fix misc remaining docs (architecture, dev quickref, sub-dir READMEs)

PLUGIN_ARCHITECTURE_SPEC.md
- Added a banner at the top noting this is a historical design doc
  written before the plugin system shipped. The doc is ~1900 lines
  with 13 stale /api/plugins/* paths (real is /api/v3/plugins/*),
  references to web_interface_v2.py (current is app.py), and a
  Migration Strategy / Implementation Roadmap that's now history.
  Banner points readers at the current docs
  (PLUGIN_DEVELOPMENT_GUIDE, PLUGIN_API_REFERENCE,
  REST_API_REFERENCE) without needing to retrofit every section.

PLUGIN_CONFIG_ARCHITECTURE.md
- 10 occurrences of /api/plugins/* missing /v3 prefix. Bulk fixed.

DEVELOPER_QUICK_REFERENCE.md
- cache_manager.delete("key") -> cache_manager.clear_cache("key")
  with comment noting delete() doesn't exist. Same bug already
  documented in PLUGIN_API_REFERENCE.md.

SSH_UNAVAILABLE_AFTER_INSTALL.md
- 4 occurrences of port 5001 -> 5000 in AP-mode and Ethernet/WiFi
  recovery instructions.

PLUGIN_CUSTOM_ICONS_FEATURE.md
- Port 5001 -> 5000.

CONFIG_DEBUGGING.md
- Documented /api/v3/config/plugin/<id> and /api/v3/config/validate
  endpoints don't exist. Replaced with the real endpoints:
  /api/v3/config/main, /api/v3/plugins/schema?plugin_id=,
  /api/v3/plugins/config?plugin_id=. Added a note that validation
  runs server-side automatically on POST.

STARLARK_APPS_GUIDE.md
- "Plugins -> Starlark Apps" UI navigation path doesn't exist (5
  occurrences). Replaced with the real path: Plugin Manager tab,
  then the per-plugin Starlark Apps tab in the second nav row.
- "Navigate to Plugins" install step -> Plugin Manager tab.

web_interface/README.md
- Documented several endpoints that don't exist in the api_v3
  blueprint:
  - GET /api/v3/plugins (list) -> /api/v3/plugins/installed
  - GET /api/v3/plugins/<id> -> doesn't exist
  - POST /api/v3/plugins/<id>/config -> POST /api/v3/plugins/config
  - GET /api/v3/plugins/<id>/enable + /disable -> POST /api/v3/plugins/toggle
  - GET /api/v3/store/plugins -> /api/v3/plugins/store/list
  - POST /api/v3/store/install/<id> -> POST /api/v3/plugins/install
  - POST /api/v3/store/uninstall/<id> -> POST /api/v3/plugins/uninstall
  - POST /api/v3/store/update/<id> -> POST /api/v3/plugins/update
  - POST /api/v3/display/start/stop/restart -> POST /api/v3/system/action
  - GET /api/v3/display/status -> GET /api/v3/system/status
- Also fixed config/secrets.json -> config/config_secrets.json
- Replaced the per-section endpoint duplication with a current real
  endpoint list and a pointer to docs/REST_API_REFERENCE.md.
- Documented that SSE stream endpoints are defined directly on the
  Flask app at app.py:607-615, not in the api_v3 blueprint.

scripts/install/README.md
- Was missing 3 of the 9 install scripts in the directory:
  one-shot-install.sh, configure_wifi_permissions.sh, and
  debug_install.sh. Added them with brief descriptions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-04-07 09:19:47 -04:00

configure_web_sudo.sh

fix(plugins): prevent root-owned files from blocking plugin updates (#242 )

2026-02-12 19:28:05 -05:00

configure_wifi_permissions.sh

fix: overhaul WiFi captive portal for reliable setup (#296 )

2026-03-27 14:50:33 -04:00

debug_install.sh

Feature/one shot installer (#178 )

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

install_service.sh

Plugins (#145 )

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

install_web_service.sh

Plugins (#145 )

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

install_wifi_monitor.sh

Feature/one shot installer (#178 )

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

migrate_config.sh

Plugins (#145 )

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

one-shot-install.sh

Fix/duplicate display settings (#173 )

2026-01-14 10:51:55 -05:00

README.md

docs: fix misc remaining docs (architecture, dev quickref, sub-dir READMEs)

2026-04-07 09:19:47 -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.