friloo/Unifi-Voucher-Tool
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 19
Unifi-Voucher-Tool/tools/README.md
Friederich Loheide 83f4223d89
Some checks are pending
CI / PHP Lint (pull_request) Waiting to run
Details
CI / PHP Lint-1 (pull_request) Waiting to run
Details
CI / Unit Tests & Static Analysis (pull_request) Waiting to run
Details
CI / PHP Lint (push) Waiting to run
Details
CI / PHP Lint-1 (push) Waiting to run
Details
CI / Unit Tests & Static Analysis (push) Waiting to run
Details
Einrichtung für einen Forgejo-Actions-Runner beilegen 
tools/runner/ enthält eine Compose-Datei, eine Beispiel-Konfiguration und
eine Schritt-für-Schritt-Anleitung, um den Runner auf dem Server zu
registrieren. Der Runner läuft in einem eigenen Verzeichnis und fasst
/opt/forgejo nicht an.

Abgestimmt auf die vorhandenen Workflows und den Server:
- Label-Zuordnung ubuntu-latest -> node:20-bookworm, damit runs-on in
  ci.yml und release.yml greift
- capacity 1 und Speicherlimit, weil der Server nur 4 GB hat
- Hinweis darauf, was das Reichen des Docker-Sockets bedeutet, und die
  Host-Modus-Alternative samt ihrer Grenzen (setup-php braucht Container)

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-23 15:06:19 +00:00

1.7 KiB
Raw Permalink Blame History

Werkzeuge

Demo-Instanz (tools/demo/build.py)

Baut aus dem Projekt eine lauffähige Kopie ohne Datenbank: Database und Auth werden durch Stubs mit festen Beispieldaten ersetzt (tools/demo/overlay/). Das Original bleibt unverändert.

python3 tools/demo/build.py /tmp/uvt-demo
php -S 127.0.0.1:8123 -t /tmp/uvt-demo

Nützlich für:

  • Screenshots für die Dokumentation – immer mit denselben Daten
  • Smoke-Test – jede Seite einmal rendern, ohne MySQL aufzusetzen

Demo-spezifische Zustände werden über Query-Parameter erreicht:

Parameter Wirkung
?demo=result / ?demo=bulk Voucher-Ergebnis bzw. Bulk-Liste auf index.php
?demo=new frisch erzeugter Schlüssel auf admin/api_keys.php
?anon=1 nicht angemeldet (für die Login-Seite)
?theme=dark erzwingt den Dark Mode
?brand=custom / ?brand=nopanel Beispiel-Branding der Login-Seite

Screenshots (tools/screenshots.py)

Rendert die Bilder aus docs/screenshots/ neu. Voraussetzung ist ein headless Chromium; der Pfad kommt aus $CHROME_BIN oder wird in den üblichen Verzeichnissen gesucht.

python3 tools/demo/build.py /tmp/uvt-demo
php -S 127.0.0.1:8123 -t /tmp/uvt-demo &
CHROME_BIN=/usr/bin/chromium python3 tools/screenshots.py

Actions-Runner (tools/runner/)

Compose-Datei und Anleitung, um einen Forgejo-Actions-Runner einzurichten. Ohne Runner bleiben ci.yml und release.yml in der Warteschlange stehen. Details: tools/runner/README.md.

Die Skripte sind Hilfsmittel für die Entwicklung – im Betrieb werden sie nicht benötigt und sind per .htaccess nicht über HTTP erreichbar.