Readme tuning
This commit is contained in:
parent
4dc16177b4
commit
6d792b95ef
3 changed files with 29 additions and 14 deletions
41
README.md
41
README.md
|
@ -118,27 +118,34 @@ Die Anwendung ist unter `http://<server-ip>:42425` erreichbar.
|
||||||
### 1. **Startseite**
|
### 1. **Startseite**
|
||||||
Rufe die Startseite unter `https://voucher.deine-schule.tld` (die im Reverseproxy konfigurierte URL) auf.
|
Rufe die Startseite unter `https://voucher.deine-schule.tld` (die im Reverseproxy konfigurierte URL) auf.
|
||||||
|
|
||||||
|
(./screenshots/startseite.png)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 2. **Voucher erstellen**
|
### 2. **Voucher erstellen**
|
||||||
- Klicken Sie auf einen der Buttons, um einen Voucher zu erstellen.
|
Ein Druck auf eine der beiden Schaltflächen startet die Magie und du erhältst:
|
||||||
- Die Seite zeigt den generierten Zugangscode und einen QR-Code an, der die WLAN-Zugangsdaten enthält.
|
|
||||||
|
(./screenshots/codeseite.png)
|
||||||
|
Die Seite zeigt den generierten Zugangscode und einen QR-Code an, der die WLAN-Zugangsdaten enthält.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## **Anpassungen**
|
## **Anpassungen**
|
||||||
|
|
||||||
### 1. **Logo ändern**
|
### 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
|
||||||
|
- ./<dein Logo>.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
|
```yaml
|
||||||
ports:
|
ports:
|
||||||
- "8080:42425"
|
- "8080:42425"
|
||||||
|
@ -169,6 +176,14 @@ docker compose logs -f
|
||||||
## **Lizenz**
|
## **Lizenz**
|
||||||
Dieses Projekt steht unter der MIT-Lizenz. Weitere Informationen finden Sie in der Datei `LICENSE`.
|
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)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
from pyunifi.controller import Controller
|
|
||||||
|
|
||||||
import os
|
import os
|
||||||
from authlib.integrations.flask_client import OAuth
|
from authlib.integrations.flask_client import OAuth
|
||||||
from flask import Flask, jsonify, request, render_template, redirect, url_for, session, send_from_directory
|
from flask import Flask, jsonify, request, render_template, redirect, url_for, session, send_from_directory
|
||||||
from werkzeug.middleware.proxy_fix import ProxyFix
|
from werkzeug.middleware.proxy_fix import ProxyFix
|
||||||
|
from pyunifi.controller import Controller
|
||||||
import uuid
|
import uuid
|
||||||
import json
|
import json
|
||||||
import qrcode
|
import qrcode
|
||||||
|
|
BIN
script/screenshots/codeseite.png
Normal file
BIN
script/screenshots/codeseite.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 90 KiB |
Loading…
Add table
Reference in a new issue