diff --git a/README.md b/README.md index 496c1b7..a92f6a1 100644 --- a/README.md +++ b/README.md @@ -118,27 +118,34 @@ Die Anwendung ist unter `http://:42425` erreichbar. ### 1. **Startseite** Rufe die Startseite unter `https://voucher.deine-schule.tld` (die im Reverseproxy konfigurierte URL) auf. - - - - +(./screenshots/startseite.png) ### 2. **Voucher erstellen** -- Klicken Sie auf einen der Buttons, um einen Voucher zu erstellen. -- Die Seite zeigt den generierten Zugangscode und einen QR-Code an, der die WLAN-Zugangsdaten enthält. +Ein Druck auf eine der beiden Schaltflächen startet die Magie und du erhältst: + +(./screenshots/codeseite.png) +Die Seite zeigt den generierten Zugangscode und einen QR-Code an, der die WLAN-Zugangsdaten enthält. --- ## **Anpassungen** ### 1. **Logo ändern** -Ersetzen Sie die Datei `/app/custom/logo.png` durch Ihr eigenes Logo. Das Logo wird auf der Startseite angezeigt. +- Lege dein Logo in das Projektverzeichnis. +- Erstelle in der docker-compose.yml einen Bind-Mount zu dieser Datei: +```yaml +... + volumes: + # Eigenes Logo einbinden - MUSS ein PNG sein + - ./.png:/app/script/static/logo.png:ro +... +``` +- Achte dabei auf die Einrückungstiefe. **volumes:** muss sich auf der selben Ebene befinden wie **image**, **ports** usw. -### 2. **WLAN-Symbol ändern** -Ersetzen Sie die Datei `/app/custom/wifi-icon.png`, um das WLAN-Symbol auf der Voucher-Seite anzupassen. -### 3. **Port ändern** -Passen Sie den Port in der `docker-compose.yml` an: + +### 2. **Port ändern** +Passe bei Bedarf den den Port in der `docker-compose.yml` an: ```yaml ports: - "8080:42425" @@ -169,6 +176,14 @@ docker compose logs -f ## **Lizenz** Dieses Projekt steht unter der MIT-Lizenz. Weitere Informationen finden Sie in der Datei `LICENSE`. ---- +1. Das Python-Script nutzt verschiedene Module: +- authlib.integrations.flask_client +- flask +- werkzeug.middleware.proxy_fix +- pyunifi.controller +- qrcode -Falls Sie Fragen oder Probleme haben, erstellen Sie bitte ein Issue im Repository. 😊 + +2. Das Wifi-Symbol habe ich von hier: [Wifi Icons No Attribution](https://www.freeiconspng.com/img/3780) + +--- diff --git a/script/app.py b/script/app.py index 8065646..6ddb6d4 100644 --- a/script/app.py +++ b/script/app.py @@ -1,9 +1,9 @@ -from pyunifi.controller import Controller import os from authlib.integrations.flask_client import OAuth from flask import Flask, jsonify, request, render_template, redirect, url_for, session, send_from_directory from werkzeug.middleware.proxy_fix import ProxyFix +from pyunifi.controller import Controller import uuid import json import qrcode diff --git a/script/screenshots/codeseite.png b/script/screenshots/codeseite.png new file mode 100644 index 0000000..bc2c8c6 Binary files /dev/null and b/script/screenshots/codeseite.png differ