Add documentation, manual and screenshots preview

2026-07-23 21:24:48 +02:00
commit d6cda77aaf
40 changed files with 1571 additions and 0 deletions
@@ -0,0 +1,142 @@
+# Installation på Raspberry Pi
+
+All rights reserved - Thomas / TuxiNet
+
+Debian 13 amd64 bruger nu [INSTALL-LINUX.md](INSTALL-LINUX.md) samt `scripts/install-linux.sh` og `scripts/update-linux.sh`.
+
+## Platform
+
+- Raspberry Pi 4 eller 5
+- Raspberry Pi OS Lite 64-bit
+- OLA/`olad`
+- Valgfrit USB audio input til BPM
+- Standardport for TuxDMX: `8000/tcp`
+
+## 1. Forbered Pi
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git curl
+git clone <privat-repo-url> tuxdmx
+cd tuxdmx
+```
+
+Hvis du deployer fra et ZIP-arkiv i stedet for Git, så udpak til en mappe og skift til den mappe før næste trin.
+
+## 2. Byg frontend før Pi-installation
+
+Kør dette på buildmaskinen eller direkte på Pi, før `install-pi.sh`:
+
+```bash
+pnpm install
+pnpm build
+```
+
+Installationsscriptet kræver, at `frontend/dist/index.html` findes.
+
+## 3. Installer TuxDMX
+
+Interaktiv installation:
+
+```bash
+sudo ./scripts/install-pi.sh
+```
+
+Ikke-interaktiv installation:
+
+```bash
+sudo ./scripts/install-pi.sh --non-interactive --force
+```
+
+Scriptet:
+
+- installerer systempakker,
+- opretter systembrugeren `tuxdmx`,
+- opretter `/opt/tuxdmx`, `/var/lib/tuxdmx`, `/var/log/tuxdmx` og `/etc/tuxdmx`,
+- genererer `/etc/tuxdmx/tuxdmx.env`,
+- installerer Python-afhængigheder,
+- kører Alembic migration,
+- installerer og starter `tuxdmx.service`.
+
+## 4. Kontroller service og URL
+
+```bash
+systemctl status tuxdmx.service
+systemctl status olad
+curl -fsS http://127.0.0.1:8000/api/v1/health
+```
+
+Web UI:
+
+```text
+http://<pi-ip>:8000/
+```
+
+## 5. Førstegangsopsætning
+
+1. Åbn Web UI.
+2. Opret administrator.
+3. Kontroller systemstatus og OLA-status.
+4. Vælg universe 1 og korrekt OLA-port.
+5. Sæt master-limit, blackout-adfærd og strobegrænser.
+6. Generér MixItUp-token ved behov.
+7. Gem safe scene.
+
+## 6. Logs og drift
+
+Følg applikationslog:
+
+```bash
+journalctl -u tuxdmx.service -f
+```
+
+Se OLA-log:
+
+```bash
+journalctl -u olad -f
+```
+
+Genstart TuxDMX:
+
+```bash
+sudo systemctl restart tuxdmx.service
+```
+
+## 7. Update
+
+```bash
+sudo ./scripts/update-pi.sh
+```
+
+Update-scriptet tager backup, kopierer ny version, installerer requirements, koerer migration og health check. Ved fejl rulles app-, data- og konfigurationstilstand tilbage.
+
+## 8. Uninstall
+
+Fjern kun service:
+
+```bash
+sudo ./scripts/uninstall-pi.sh
+```
+
+Fjern service og app:
+
+```bash
+sudo ./scripts/uninstall-pi.sh --purge-app
+```
+
+Fjern service, app og data:
+
+```bash
+sudo ./scripts/uninstall-pi.sh --purge-app --purge-data
+```
+
+## 9. Fejlsøgning
+
+- Health fejler: se `journalctl -u tuxdmx.service -n 200`
+- OLA utilgængelig: se `journalctl -u olad -n 200`
+- USB-DMX ikke fundet: brug `lsusb`, `dmesg | grep -i usb` og [HARDWARE-VALIDATION.md](HARDWARE-VALIDATION.md)
+- Databasefejl: kontrollér `/var/lib/tuxdmx/tuxdmx.db` og `sqlite3 /var/lib/tuxdmx/tuxdmx.db "PRAGMA integrity_check;"`
+
+## 10. Ikke fysisk testet af Codex
+
+Denne repository leverer scripts og dokumentation til Pi, men ingen fysisk Raspberry Pi-, OLA- eller USB-DMX-hardware er testet i denne desktop-session. Brug altid [HARDWARE-VALIDATION.md](HARDWARE-VALIDATION.md) efter installation.