# 🎫 UniFi Voucher Management System **Webbasiertes WLAN-Voucher-Management für UniFi OS** – mit Multi-Site-Support, Benutzerverwaltung, Microsoft-365-Login und integriertem Auto-Updater. Entwickelt von **[Loheide.eu](https://loheide.eu)** ![PHP](https://img.shields.io/badge/PHP-8.1%2B-777BB4?logo=php&logoColor=white) ![MySQL](https://img.shields.io/badge/MySQL-5.7%2B%20%2F%20MariaDB-4479A1?logo=mysql&logoColor=white) ![UniFi OS](https://img.shields.io/badge/UniFi%20OS-7.0%2B-0559C9?logo=ubiquiti&logoColor=white) ![License](https://img.shields.io/badge/Lizenz-MIT-green) ![Version](https://img.shields.io/badge/Version-3.0.1-blueviolet) [![CI](https://git.loheide.cloud/friloo/Unifi-Voucher-Tool/badges/workflows/ci.yml/badge.svg)](https://git.loheide.cloud/friloo/Unifi-Voucher-Tool/actions) [![Repository](https://img.shields.io/badge/Code-git.loheide.cloud-4b3ec4)](https://git.loheide.cloud/friloo/Unifi-Voucher-Tool)
---
Erstellter Voucher mit QR-Code Admin Dashboard
--- ## ✨ Features - 🎟️ **Voucher-Erstellung** mit sofortiger QR-Code-Anzeige, Druckvorlage und E-Mail-Versand - 🖥️ **Display-Seiten (Kiosk)** – öffentliche Seite je Site, an der Gäste sich mit einem Klick selbst einen Zugang holen - 🎨 **Jede Display-Seite eigenständig gestaltbar** – Logo, Hintergrundbild, Akzentfarbe, helle oder dunkle Karte - 📦 **Bulk-Erstellung** – bis zu 20 Vouchers auf einmal, inkl. Sammeldruck-Layout - 🧩 **Voucher-Profile/Templates** – vordefinierte Laufzeiten & Gerätelimits per Schnellauswahl - 🏢 **Multi-Site-Support** – beliebig viele UniFi-Standorte zentral verwalten - 👥 **Benutzerverwaltung** mit granularer Site-Zugriffskontrolle - 🔐 **Authentifizierung** via lokale Accounts **oder** Microsoft 365 OAuth - 🔒 **2FA (TOTP)** – optional, mit Recovery-Codes & erzwingbarer Admin-Pflicht - 📈 **Reporting** – Auswertungen mit Charts und CSV-/PDF-Export - 🩺 **Health-Endpoint** (`/health.php`) für Monitoring/Uptime - 🔑 **Passwort-Reset** per E-Mail (token-basiert, zeitlich begrenzt) - 🚦 **Bandbreiten- & Datenlimits** pro Voucher/Profil (UniFi QoS) - 🧰 **REST-API mit API-Schlüsseln** – Scopes (read/write), Rate-Limit, OpenAPI-Spec - 🪪 **Single Sign-On** via generisches OpenID Connect (zusätzlich zu M365) - 📲 **SMS-Versand** der Codes (Twilio) · **CSV-Batch-Import** von Vouchern - 🤖 **CAPTCHA** (Rechenaufgabe oder hCaptcha) im öffentlichen Modus - 🗄️ **DB-gestützte Sessions** (opt-in) mit „überall abmelden" - 🔔 **Webhooks** (Slack / Teams / generisch) für Erstellung, Ausfälle, neue Login-IP - 🧹 **Auto-Cleanup & DSGVO** – Aufbewahrungsfristen per Cron - 💾 **Config-Backup & -Restore** (JSON Export/Import) - 🐳 **Docker** – Dockerfile + docker-compose (MariaDB) - 🌍 **Öffentlicher Modus** – optional ohne Login nutzbar (mit CSRF-Schutz & Throttle) - 🎨 **Einheitliches Design-System** – ein Stylesheet für Frontend, Login und Backend (Tokens, Komponenten, Light/Dark) - 🏷️ **Login-Seite individualisierbar** – Firmenname, Logo, Texte, Hintergrundbild bzw. Farbverlauf - 🖌️ **Eigene Markenfarben** – Akzentfarbe, Verlauf und Eckenradius wirken auf die gesamte Oberfläche - ⬆️ **Bild-Upload** für Logo, Favicon und Login-Hintergrund (kein externes Hosting nötig) - 🔒 **Keine externen CDNs** – Schrift, Icons, Diagramme und Editor werden lokal ausgeliefert (DSGVO, Offline-Netze) - ♿ **Barrierearm** – Kontraste nach WCAG AA, Sprungmarke, aria-Beschriftungen, `prefers-reduced-motion` - 📱 **Mobil nutzbar** – Tabellen werden auf schmalen Geräten zu Karten - 🌗 **Dark Mode** – umschaltbar, Einstellung wird im Browser gespeichert - 🌐 **Mehrsprachig** – Deutsch / Englisch per Umschalter (`lang/`) - 📱 **Responsive Admin-Layout** mit Hamburger-Menü & Sidebar-Overlay - 📊 **Admin-Dashboard** mit Live-Statistiken und Sync-Funktion - 📝 **Audit-Log** – nachvollziehbare Protokollierung von Login & Änderungen (mit Filter) - 📥 **CSV-Export** aller Vouchers pro Site - 🔄 **Integrierter Auto-Updater** – Updates & DB-Migrationen per Klick aus dem Admin-Bereich - 🛡️ **Security-by-default**: CSRF-Schutz, bcrypt-Passwörter, Prepared Statements, Login-Rate-Limiting, OAuth-State-Validierung, Verschlüsselung sensibler Daten --- ## 📸 Screenshots > Alle Screenshots stammen aus der Oberfläche in Version 2.5.0 (neues Design-System). ### Anmeldung & Voucher-Erstellung
Anmeldung Anmeldung mit eigenem Branding
Voucher erstellen Einstellungen der Login-Seite
### Display-Seite für Gäste
Display-Seite im Ruhezustand Display-Seite mit eigenem Bild und Farben
Ausgegebener Zugangscode auf dem Display Display-Seite einrichten
Voucher-Ergebnis mit QR-Code Bulk-Voucher-Erstellung
### Administration
Dashboard Dashboard im Dark Mode
Live-Voucher-Verwaltung Einstellungen
Markenfarben einstellen Ansicht auf dem Smartphone
### REST-API, 2FA & Integrationen
API-Schlüssel-Verwaltung Integration & Wartung
Zwei-Faktor-Authentifizierung
### Updater & Wartungsmodus
Updater – Ausgangszustand Auto-Updater mit verfügbarem Update
Wartungsmodus
--- ## 📋 Anforderungen | Komponente | Version | |---|---| | PHP | 8.1+ (mit PDO, PDO_MySQL, cURL, mbstring, JSON; empfohlen: OpenSSL/libsodium, Zip) | | Datenbank | MySQL 5.7+ / MariaDB 10.2+ | | Webserver | Apache / Nginx | | UniFi | **Network Application 7.0+ mit UniFi OS** (z. B. UDM, UDR, UniFi OS Server) | --- ## 🚀 Installation ```bash git clone https://git.loheide.cloud/friloo/Unifi-Voucher-Tool.git cd Unifi-Voucher-Tool ``` 1. Dateien auf den Webserver hochladen 2. `https://ihre-domain.de/install.php` öffnen 3. Den **5-Schritte-Assistenten** durchlaufen: 1. Datenbank-Verbindungsdaten 2. Administrator-Account 3. Allgemeine Einstellungen (Titel, Logo, öffentlicher Zugriff) 4. Microsoft 365 Integration (optional) 5. Installation abschließen 4. `install.php` nach erfolgreicher Installation **löschen** > 🔒 Der Installer erzeugt automatisch einen zufälligen `APP_KEY` (für die > Verschlüsselung der UniFi-Passwörter) und eine `.htaccess`, die sensible > Dateien sperrt. Ein erneuter Aufruf von `install.php?reinstall=1` ist nur > für **angemeldete Administratoren** möglich. ### Sites konfigurieren 1. **Administration → Sites verwalten → Neue Site hinzufügen** 2. Felder ausfüllen: - **Name:** Anzeigename (z. B. „Hauptgebäude") - **Site ID:** UniFi Site ID (meist `default`) - **Controller URL:** `https://unifi.example.com:11443` - **Benutzername / Passwort:** UniFi Admin-Zugangsdaten - **Zertifikat des Controllers prüfen:** optional, siehe unten 3. **Verbindung testen** klicken, dann speichern > **Zertifikatsprüfung:** UniFi-Geräte liefern ab Werk ein selbst signiertes > Zertifikat, deshalb ist die Prüfung standardmäßig **aus** – sonst käme keine > Verbindung zustande. Läuft der Controller unter seinem echten Namen mit einem > gültigen Zertifikat (eigene CA oder Let's Encrypt), schalten Sie die Prüfung > pro Site ein; die Verbindung ist dann gegen Man-in-the-Middle abgesichert. > Für den Mailversand gibt es denselben Schalter unter **Einstellungen → SMTP**. ### Voucher erstellen 1. Startseite öffnen (Login je nach Konfiguration optional) 2. Voucher-Name, Anzahl Geräte und Standort wählen 3. **Voucher erstellen** – Code und QR-Code werden sofort angezeigt 4. Code per E-Mail senden oder ausdrucken --- ## 🔄 Selbst-Updater Eine laufende Installation aktualisiert sich per Klick im Administrationsbereich – **ohne SSH und ohne `git pull` auf dem Server**. Quellcode und Datenbank-Migrationen kommen über einen Update-Dienst, der den aktuellen Stand des Branches als ZIP bereitstellt. ``` [diese Installation] ←HTTPS→ [Update-Dienst] ←pull→ [Git-Repository] ``` **Aufruf:** Administration → **Aktualisierung** (`/admin/update.php`) - 🔍 **„Nach Updates suchen"** zeigt, ob eine neue Fassung da ist, welche Version sie trägt und – sofern der Dienst etwas liefert – die Abschnitte aus dem Änderungsprotokoll. Gibt es dazu nichts, bleibt es bei der schlichten Aussage „neue Fassung verfügbar" - ⬇️ **„Jetzt aktualisieren"** spielt sie ein: Wartungsseite, Prüfsumme, gesichertes Entpacken, geschützte Pfade, Migrationen, Bytecode-Cache. Der Fortschritt wird alle zwei Sekunden abgefragt; der Ablauf läuft serverseitig weiter, auch wenn der Browser die Verbindung kappt - 🔀 **Kanal** zwischen `stable` und `development` umschaltbar - 📊 **Migrationen** mit Status je Datei und Schaltfläche zum Nachziehen - 📜 **Änderungsprotokoll** aus der mitgelieferten `CHANGELOG.md` Während eines Updates antwortet die Anwendung mit einer **Wartungsseite** (HTTP 503 samt `Retry-After`) – ausgenommen die Update-Endpunkte selbst, die Anmeldeseite und der Health-Check, damit der Fortschritt sichtbar bleibt:
Wartungsmodus
**Was dabei geschützt ist:** `config.php`, `uploads/`, `vendor/`, `updater/storage/` und weitere Pfade werden nie überschrieben. Dateien werden einzeln erst daneben geschrieben und dann umbenannt, damit ein Abbruch keine halbe PHP-Datei hinterlässt. Gelöscht wird nichts. Das Paket wird gegen die vom Dienst genannte SHA-256 geprüft, und beim Entpacken verhindern zwei unabhängige Prüfungen, dass ein Archiv aus seinem Verzeichnis ausbricht. > **Datenschutz:** Die Update-Prüfung überträgt den installierten Stand sowie > technisch bedingt IP-Adresse und Zeitpunkt an `update.loheide.cloud`. Inhalte > aus dem Programm werden nicht übertragen. Der vollständige Hinweis steht > dauerhaft auf der Seite „Aktualisierung", direkt neben der Schaltfläche. Architektur, Sicherheitseigenschaften und eine Rückbau-Anleitung stehen in [`updater/README.md`](updater/README.md). ### Eine neue Fassung veröffentlichen 1. `CHANGELOG.md`: Abschnitt `## MAJOR.MINOR.PATCH – Datum` ergänzen 2. `Updater\Version::RELEASE` und die Datei `VERSION` anheben (Patch = Fehlerbehebung, Minor = Funktion) – ein Test prüft, dass beide übereinstimmen 3. `composer test` und `composer stan` grün, kompilierte Assets mitversionieren (beim Anwender läuft kein Build) 4. Merge nach `main` – sobald der Dienst den Stand gespiegelt hat, bieten ihn alle Installationen an --- ## 🖥️ Display-Seiten für Gäste Für Empfang, Lobby oder Tagungsraum lässt sich je Site eine **öffentliche Seite** anlegen, die auf einem Bildschirm oder Tablet läuft. Gäste tippen auf einen Knopf und bekommen sofort einen eigenen Zugangscode – ohne Anmeldung, ohne Personal am Tresen. **Anlegen:** Administration → **Display-Seiten** → *Display-Seite anlegen*
Verwaltung der Display-Seiten
| Einstellung | Wirkung | |---|---| | Site | für welchen Standort die Codes erzeugt werden | | Voucher-Profil | Laufzeit, Geräteanzahl und Bandbreite der Codes (leer = Standardwerte) | | Überschrift / Text | was auf dem Bildschirm steht | | Codes pro Tag | Obergrenze je Kalendertag (0 = unbegrenzt) | | Wartezeit | Abstand zwischen zwei Codes an diesem Display | | Wartezeit je Gerät | zusätzliche Sperre pro Browser (Cookie) – gegen das Leerziehen durch eine Person | | Servicezeiten | z. B. 06:00–23:00; außerhalb erscheint ein Hinweis statt des Knopfes. Fenster über Mitternacht möglich | | PIN | optionale Eingabe, sinnvoll bei frei zugänglichen Bildschirmen | | Sprache | feste Sprache des Displays oder automatisch nach Browsersprache | | Anzeigedauer | danach springt der Bildschirm automatisch zurück | Jede Seite hat einen **eigenen, geheimen Link** (`kiosk.php?k=…`). Er lässt sich kopieren, als QR-Code anzeigen (praktisch, um ihn am Tablet zu öffnen) und jederzeit erneuern – der alte Link ist dann sofort ungültig. Den Link nicht öffentlich verbreiten: wer ihn hat, kann im Rahmen der Limits Codes ziehen. Auf dem Startbildschirm steht zusätzlich ein QR-Code, der auf dieselbe Seite zeigt. Gäste können sie damit **am eigenen Handy** öffnen – praktisch bei Bildschirmen ohne Touch. ### Jede Seite eigenständig gestalten Jede Display-Seite bringt ihr eigenes Erscheinungsbild mit – das Hotel am Empfang sieht anders aus als der Tagungsraum nebenan: | Einstellung | Wirkung | |---|---| | Logo | eigenes Logo auf der Karte (leer = Logo aus den Einstellungen) | | Hintergrundbild | formatfüllend hinter der Karte, z. B. ein Foto des Hauses | | Abdunklung | 0–90 % dunkle Ebene über dem Bild, damit die Karte lesbar bleibt | | Akzentfarbe | färbt den Knopf dieser Seite (leer = Farbe aus dem Design-Tab) | | Karte | hell oder dunkel – auf Fotos wirkt die dunkle Karte meist ruhiger | Logo und Hintergrund lassen sich direkt hochladen (PNG, JPG, WEBP, GIF, SVG bis 3 MB) oder als URL hinterlegen; beim Löschen einer Display-Seite verschwinden die hochgeladenen Dateien mit. Die ausgegebenen Codes erscheinen normal in *Live Vouchers*, im *Reporting* – dort gibt es eine eigene Auswertung **„Pro Display-Seite"** – und im *Audit-Log* (Aktion „Voucher am Display geholt"), sodass jederzeit nachvollziehbar bleibt, woher ein Zugang stammt. In der Verwaltung zeigt **„Vorschau"** die Seite direkt im Admin-Bereich, ohne den Tab zu wechseln. Gäste können die Sprache unten auf dem Display selbst umschalten. > Display-Seiten funktionieren unabhängig vom globalen öffentlichen Modus – der > geheime Link ist der Zugang. Webhook-Benachrichtigungen werden für diese Codes > bewusst **nicht** ausgelöst, sonst wäre der Slack-Kanal voll. --- ## ⚙️ Konfiguration ### `config.php` Wird automatisch durch den Installer erstellt: ```php **Apache:** `AllowOverride All` muss für das Verzeichnis gesetzt sein, sonst > werden die `.htaccess`-Dateien ignoriert. Das mitgelieferte Docker-Image > erledigt das bereits. > **Caddy liest keine `.htaccess`.** Läuft das Tool hinter Caddy, müssen die > Regeln in den Caddyfile – eine fertige Vorlage liegt unter > [`docs/Caddyfile.example`](docs/Caddyfile.example). Besonders wichtig ist > dort die Sperre, die PHP-Dateien unterhalb von `uploads/` nicht ausführt. Für **Nginx** entspricht das: ```nginx add_header X-Content-Type-Options "nosniff" always; add_header X-Frame-Options "SAMEORIGIN" always; add_header Referrer-Policy "strict-origin-when-cross-origin" always; add_header Content-Security-Policy "default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self'; frame-ancestors 'self'" always; location ~ ^/(includes|tools|tests)/ { deny all; } location ~ ^/updater/(storage|migrations)/ { deny all; } location ~ ^/(config\.php|database\.sql)$ { deny all; } location ^~ /uploads/ { location ~ \.php$ { deny all; } } ``` ```sql -- Dedizierter Datenbank-Benutzer mit minimalen Rechten CREATE USER 'unifi_voucher'@'localhost' IDENTIFIED BY 'sicheres_passwort'; GRANT SELECT, INSERT, UPDATE, DELETE ON unifi_voucher.* TO 'unifi_voucher'@'localhost'; ``` --- ## 🩺 Problembehandlung
Login funktioniert nicht - Datenbankverbindung und PHP-Session-Konfiguration prüfen - Fehler werden ins PHP-Error-Log geschrieben (nicht mehr in den Browser)
UniFi-Verbindung schlägt fehl - Controller-URL im Browser testen - Port **11443** für UniFi OS verwenden (nicht 8443) - Benutzername, Passwort und Site ID prüfen - cURL-Extension muss aktiviert sein
UniFi OS: HTTP 404 oder 401 - Login-Endpunkt ist `/api/auth/login` (nicht `/api/login`) - API-Pfade benötigen Präfix `/proxy/network/api/s/{site}/...` - Älterer UniFi Network Controller (ohne UniFi OS) wird ab Version 2.1.0 nicht mehr unterstützt
Microsoft 365 Login funktioniert nicht - Redirect URI in Azure AD prüfen - Client ID, Secret und Tenant ID kontrollieren
--- ## 📡 API-Dokumentation (UniFi OS) ```http # Login POST /api/auth/login Body: {"username": "admin", "password": "password"} Response-Header: X-CSRF-Token: # Voucher erstellen POST /proxy/network/api/s/{site_id}/cmd/hotspot X-CSRF-Token: Body: {"cmd": "create-voucher", "expire": 480, "n": 1, "note": "Name", "quota": 1} # Vouchers abrufen GET /proxy/network/api/s/{site_id}/stat/voucher # Voucher löschen POST /proxy/network/api/s/{site_id}/cmd/hotspot Body: {"cmd": "delete-voucher", "_id": ""} ``` --- ## 🧰 REST-API Voucher lassen sich programmatisch erstellen (z. B. aus Buchungssystemen oder Self-Service-Terminals). Schlüssel werden unter **Administration → API-Schlüssel** verwaltet. Authentifizierung per `Authorization: Bearer ` oder `X-API-Key`. ```bash # Voucher erstellen curl -X POST https://ihre-domain.de/api/vouchers.php \ -H "Authorization: Bearer uvt_…" \ -H "Content-Type: application/json" \ -d '{"site_id":1,"name":"API Gast","max_uses":1,"expire_minutes":480, "qos":{"down":10000,"up":2000,"quota_mb":500}}' # Sites auflisten curl https://ihre-domain.de/api/sites.php -H "X-API-Key: uvt_…" # Voucher einer Site abrufen curl "https://ihre-domain.de/api/vouchers.php?site_id=1" -H "X-API-Key: uvt_…" ``` | Methode | Endpunkt | Zweck | |---|---|---| | `POST` | `/api/vouchers.php` | Voucher erstellen (optional mit QoS-Limits) | | `GET` | `/api/vouchers.php?site_id=` | Voucher einer Site auflisten | | `GET` | `/api/sites.php` | Aktive Sites auflisten | ## 🔒 2FA, Webhooks & Wartung - **2FA:** Unter **Administration → Sicherheit (2FA)** aktivierbar – QR-Code scannen, Code bestätigen. Danach wird bei jeder Anmeldung ein Authenticator- Code abgefragt. - **Webhooks & Trusted-Proxy & Datenhaltung:** unter **Administration → Integration & Wartung** konfigurierbar. - **Auto-Cleanup (DSGVO):** täglicher Cron, löscht abgelaufene Voucher, Audit-Log, Login-Versuche nach einstellbaren Fristen: ```bash 0 3 * * * curl -s "https://ihre-domain.de/cron_cleanup.php?token=IHR_CRON_TOKEN" ``` ## 🐳 Docker ```bash # APP_KEY erzeugen und in docker-compose.yml eintragen: php -r 'echo base64_encode(random_bytes(32))."\n";' docker compose up -d # App auf http://localhost:8080 ``` Das Schema wird beim ersten Start automatisch in MariaDB geladen; danach den Installer (`/install.php`) für den Admin-Account aufrufen oder Config per ENV setzen (`DB_*`, `APP_KEY`). Hochgeladene Logos und Hintergründe liegen im Volume `uploads` und überstehen damit ein Image-Update. Bei eigener Apache-/Nginx-Installation muss `uploads/` für den Webserver beschreibbar sein: ```bash chown -R www-data:www-data uploads updater/storage ``` --- ## 🧪 Entwicklung Für Screenshots und einen schnellen Durchlauf aller Seiten gibt es eine Demo-Instanz **ohne Datenbank** – `Database` und `Auth` werden durch Stubs mit festen Beispieldaten ersetzt: ```bash python3 tools/demo/build.py /tmp/uvt-demo php -S 127.0.0.1:8123 -t /tmp/uvt-demo & # Bilder in docs/screenshots neu erzeugen (benötigt headless Chromium) CHROME_BIN=/usr/bin/chromium python3 tools/screenshots.py ``` Details und die verfügbaren Demo-Zustände: [`tools/README.md`](tools/README.md). Tests und statische Analyse: ```bash composer install vendor/bin/phpunit # 62 Tests vendor/bin/phpstan analyse # Level 5 ``` Die Tests decken die Stellen ab, an denen Fehler teuer werden: | Bereich | Was geprüft wird | |---|---| | `AuthTest` | Anmeldung, Rate-Limit, 2FA-Zwischenschritt, CSRF, Client-IP hinter Proxy | | `UniFiControllerTest` | Auswahl des eigenen Vouchers bei parallelen Anfragen, QoS-Payload, Fehlerfälle | | `KioskTest` | Token-Prüfung, Wartezeit, Tageslimit, Gestaltung | | `UploadTest` | SVG-Filter und Pfad-Prüfung | | `UiTest` | Versionsstempel, Media-Pfade, Branding-Overrides | | `CryptoTest`, `TotpTest`, `ApiKeyTest` | Verschlüsselung, Einmalcodes, Schlüssel-Hashing | `AuthTest` und `UniFiControllerTest` kommen ohne Datenbank und ohne erreichbaren Controller aus: `Auth` nimmt die Datenbank über den Konstruktor entgegen, beim Controller spielen die Tests aufgezeichnete API-Antworten ein. Die Versionsnummer steht in der Datei **`VERSION`** im Projektstamm. Sie wird im Admin-Bereich unten in der Seitenleiste angezeigt und benennt das Release-Paket – für eine neue Version also dort (und im Badge oben) anheben. Die Pipeline (`.github/workflows/ci.yml`) führt zusätzlich einen Syntax-Check über alle PHP-Dateien aus und prüft, ob `lang/de.php` und `lang/en.php` dieselben Schlüssel enthalten und jeder im Code verwendete Schlüssel existiert. Dieselben Schritte lassen sich lokal ausführen. --- ## 📦 Repository & Mitwirken Der Quellcode liegt auf der eigenen Forgejo-Instanz – **nicht** auf GitHub: **** ```bash # HTTPS git clone https://git.loheide.cloud/friloo/Unifi-Voucher-Tool.git # SSH (Port 2222) git clone ssh://git@git.loheide.cloud:2222/friloo/Unifi-Voucher-Tool.git ``` ### Fertige Pakete Jeder Merge nach `main` erzeugt automatisch ein installierbares ZIP (`.github/workflows/release.yml`) und hängt es an das rollende Vorab-Release **`latest-main`**: **** Das Paket enthält nur die Laufzeit-Dateien – `docs/`, `tests/`, `tools/` und die CI-Konfiguration bleiben draußen (rund 1,4 MB). Wird ein Tag `v*` gepusht, entsteht daraus ein reguläres Release mit derselben Mechanik. > Beim **Update einer bestehenden Installation** `config.php`, `uploads/` und > `updater/storage/` nicht überschreiben – oder gleich den eingebauten Updater > verwenden, der genau diese Pfade schützt. Gebaut wird das von einem **Forgejo-Actions-Runner**, der auf dem Server läuft. Compose-Datei und Einrichtungsanleitung liegen in [`tools/runner/`](tools/runner/README.md) – nötig für eine Neuinstallation oder wenn der Runner ersetzt wird. ### Mitwirken Fehlerberichte und Änderungsvorschläge laufen über die **Issues** und **Pull Requests** dort. Für die Kommandozeile eignet sich [`tea`](https://gitea.com/gitea/tea), die Gitea-/Forgejo-CLI: ```bash tea pr create # Pull Request öffnen tea issues ls # offene Tickets ansehen ``` > Die Workflows unter `.github/workflows/` werden von Forgejo Actions > mitgelesen – geblieben sind `ci.yml` (Lint, Tests, statische Analyse) und > `release.yml` (Release-ZIP). Das frühere `docker-publish.yml` veröffentlichte > nach `ghcr.io` und stammte noch aus der GitHub-Zeit; es ist entfernt. Das > Image wird stattdessen lokal gebaut (siehe Abschnitt **Docker**). Der **Auto-Updater** ist davon unabhängig: er zieht seine Pakete über `update.loheide.eu` (Channels `stable` und `development`) und nicht direkt aus dem Git-Hoster. --- ## 📄 Lizenz Der eigene Code steht unter der **MIT-Lizenz** – siehe [`LICENSE`](LICENSE). Kurz gefasst: verwenden, ändern und weitergeben ist erlaubt, auch kommerziell, solange Copyright- und Lizenzhinweis erhalten bleiben; eine Gewährleistung gibt es nicht. Mitgeliefert werden außerdem Bibliotheken Dritter unter ihren eigenen Lizenzen. Die Übersicht mit allen Copyright-Angaben steht in [`THIRD-PARTY-NOTICES.md`](THIRD-PARTY-NOTICES.md), die vollständigen Lizenztexte liegen jeweils im zugehörigen Ordner unter `assets/vendor/`: | Komponente | Version | Lizenz | |---|---|---| | Inter | 4.0 | SIL OFL 1.1 | | Font Awesome Free | 6.4.0 | Icons CC BY 4.0 · Schriften SIL OFL 1.1 · Code MIT | | Chart.js | 4.4.0 | MIT | | qrcodejs | 1.0.0 | MIT | | TinyMCE | 6.8.3 | MIT | `LICENSE`, `THIRD-PARTY-NOTICES.md` und die Lizenzdateien der Bibliotheken sind Teil jedes Release-ZIPs – wer die Anwendung weitergibt, gibt die Hinweise also automatisch mit. Dieselbe Übersicht steht in der laufenden Installation unter **Administration → Integration & Wartung → Über diese Installation**, dort zusammen mit Version und PHP-Version und mit Links auf die ausgelieferten Lizenztexte. --- ## 🗺️ Roadmap - [x] Voucher-Templates (vordefinierte Laufzeiten) - [x] Bulk-Voucher-Erstellung - [x] Mehrsprachigkeit (DE/EN) - [x] Dark Mode - [x] Passwort-Reset - [x] Audit-Log - [x] Auto-Updater mit DB-Migrationen - [x] REST-API mit API-Schlüsseln - [x] 2FA (TOTP), Webhooks, Bandbreitenlimits - [x] Docker-Container - [x] Erweiterte Reporting-Funktionen (CSV/PDF) + Health-Endpoint - [x] 2FA-Recovery-Codes, API-Scopes/Rate-Limit/OpenAPI, Test-Suite (PHPUnit/PHPStan) - [x] Gemeinsames Design-System für Frontend, Login und Backend - [x] Branding über die Oberfläche (Farben, Logo, Login-Seite) - [x] Assets lokal ausliefern (keine Drittanbieter-CDNs) - [x] Vollständige englische Übersetzung des Admin-Bereichs - [x] Display-Seiten: Selbstbedienung für Gäste am Bildschirm ---
**Version 3.0.1** · Autor: **Friederich Loheide** · Lizenz: **MIT** Entwickelt von **[Loheide.eu](https://loheide.eu)**