Remove deprecated backend files and documentation, including Docker configurations, environment variables, and various scripts, to streamline the project structure and eliminate unused components.
This commit is contained in:
@@ -1,647 +0,0 @@
|
||||
# MYP Backend API-Dokumentation
|
||||
|
||||
Dieses Dokument beschreibt detailliert die API-Endpunkte des MYP (Manage Your Printer) Backend-Systems.
|
||||
|
||||
## Basis-URL
|
||||
|
||||
Die Basis-URL für alle API-Anfragen ist: `http://localhost:5000` (Entwicklungsumgebung) oder die URL, unter der die Anwendung gehostet wird.
|
||||
|
||||
## Authentifizierung
|
||||
|
||||
Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cookies/Sessions, die bei der Anmeldung erstellt werden. Die Session wird für 7 Tage gespeichert.
|
||||
|
||||
### Benutzerregistrierung
|
||||
|
||||
**Endpunkt:** `POST /auth/register`
|
||||
|
||||
**Beschreibung:** Registriert einen neuen Benutzer im System.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string", // Erforderlich
|
||||
"displayName": "string", // Optional (Standard: username)
|
||||
"email": "string" // Optional
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Registrierung erfolgreich!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzername bereits vergeben!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzeranmeldung
|
||||
|
||||
**Endpunkt:** `POST /auth/login`
|
||||
|
||||
**Beschreibung:** Meldet einen Benutzer an und erstellt eine Session.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string" // Erforderlich
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Anmeldung erfolgreich!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Ungültiger Benutzername oder Passwort!"
|
||||
}
|
||||
```
|
||||
|
||||
### Initialer Administrator
|
||||
|
||||
**Endpunkt:** `POST /api/create-initial-admin`
|
||||
|
||||
**Beschreibung:** Erstellt einen initialen Admin-Benutzer, falls noch keiner existiert.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string", // Erforderlich
|
||||
"displayName": "string", // Optional (Standard: username)
|
||||
"email": "string" // Optional
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Administrator wurde erfolgreich erstellt!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Es existiert bereits ein Administrator!"
|
||||
}
|
||||
```
|
||||
|
||||
## Benutzer-Endpunkte
|
||||
|
||||
### Alle Benutzer abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/users`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Benutzer zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Benutzer abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Benutzers zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzer aktualisieren (Admin)
|
||||
|
||||
**Endpunkt:** `PUT /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Daten eines Benutzers.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"password": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzername bereits vergeben!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzer löschen (Admin)
|
||||
|
||||
**Endpunkt:** `DELETE /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Benutzer.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzer gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
## Drucker-Endpunkte
|
||||
|
||||
### Alle Drucker abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/printers`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Drucker (Steckdosen) zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"status": 0, // 0 = available, 1 = busy
|
||||
"latestJob": {
|
||||
// Job-Objekt oder null, wenn kein aktiver Job
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Drucker hinzufügen (Admin)
|
||||
|
||||
**Endpunkt:** `POST /api/printers`
|
||||
|
||||
**Beschreibung:** Fügt einen neuen Drucker hinzu.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"ipAddress": "string" // IP-Adresse der Tapo-Steckdose
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"status": 0, // 0 = available, 1 = busy
|
||||
"latestJob": null
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Druckers zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"status": 0, // 0 = available, 1 = busy
|
||||
"latestJob": {
|
||||
// Job-Objekt oder null, wenn kein aktiver Job
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker aktualisieren (Admin)
|
||||
|
||||
**Endpunkt:** `PUT /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Daten eines Druckers.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"ipAddress": "string", // IP-Adresse der Tapo-Steckdose
|
||||
"status": 0 // 0 = available, 1 = busy
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"name": "string",
|
||||
"description": "string",
|
||||
"status": 0, // 0 = available, 1 = busy
|
||||
"latestJob": {
|
||||
// Job-Objekt oder null, wenn kein aktiver Job
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker löschen (Admin)
|
||||
|
||||
**Endpunkt:** `DELETE /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Drucker.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Drucker gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
## Druckauftrags-Endpunkte
|
||||
|
||||
### Alle Druckaufträge abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/jobs`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Druckaufträge zurück (für Admins) oder der eigenen Druckaufträge (für Benutzer).
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 30
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Druckauftrag erstellen
|
||||
|
||||
**Endpunkt:** `POST /api/jobs`
|
||||
|
||||
**Beschreibung:** Erstellt einen neuen Druckauftrag.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"printerId": "uuid-string",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 60
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Drucker ist nicht verfügbar!"
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/jobs/{jobId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Druckauftrags zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 30
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag Kommentare aktualisieren
|
||||
|
||||
**Endpunkt:** `PUT /api/jobs/{jobId}/comments`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Kommentare eines Druckauftrags.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"comments": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 30
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag abbrechen
|
||||
|
||||
**Endpunkt:** `POST /api/jobs/{jobId}/abort`
|
||||
|
||||
**Beschreibung:** Bricht einen laufenden Druckauftrag ab.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"reason": "string" // Optional
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": true,
|
||||
"abortReason": "string",
|
||||
"remainingMinutes": 0
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag vorzeitig beenden
|
||||
|
||||
**Endpunkt:** `POST /api/jobs/{jobId}/finish`
|
||||
|
||||
**Beschreibung:** Beendet einen laufenden Druckauftrag vorzeitig.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 45, // Tatsächliche Dauer bis zum Beenden
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 0
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag verlängern
|
||||
|
||||
**Endpunkt:** `POST /api/jobs/{jobId}/extend`
|
||||
|
||||
**Beschreibung:** Verlängert die Laufzeit eines Druckauftrags.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"minutes": 30, // Zusätzliche Minuten
|
||||
"hours": 0 // Zusätzliche Stunden (optional)
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 90, // Aktualisierte Gesamtdauer
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 60
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag löschen
|
||||
|
||||
**Endpunkt:** `DELETE /api/jobs/{jobId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Druckauftrag.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Druckauftrag gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
### Verbleibende Zeit eines Druckauftrags abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/job/{jobId}/remaining-time`
|
||||
|
||||
**Beschreibung:** Gibt die verbleibende Zeit eines aktiven Druckauftrags in Minuten zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"remaining_minutes": 30,
|
||||
"job_status": "active", // active, completed
|
||||
"socket_status": "busy" // busy, available
|
||||
}
|
||||
```
|
||||
|
||||
### Status eines Druckauftrags abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/job/{jobId}/status`
|
||||
|
||||
**Beschreibung:** Gibt detaillierte Statusinformationen zu einem Druckauftrag zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"job": {
|
||||
"id": "uuid-string",
|
||||
"socketId": "uuid-string",
|
||||
"userId": "uuid-string",
|
||||
"startAt": "string (ISO 8601)",
|
||||
"durationInMinutes": 60,
|
||||
"comments": "string",
|
||||
"aborted": false,
|
||||
"abortReason": null,
|
||||
"remainingMinutes": 30
|
||||
},
|
||||
"status": "active", // active, completed, aborted
|
||||
"socketStatus": "busy", // busy, available
|
||||
"remainingMinutes": 30
|
||||
}
|
||||
```
|
||||
|
||||
## Statistik-Endpunkte
|
||||
|
||||
### Systemstatistiken abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/stats`
|
||||
|
||||
**Beschreibung:** Gibt Statistiken zu Druckern, Aufträgen und Benutzern zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"printers": {
|
||||
"total": 10,
|
||||
"available": 5,
|
||||
"utilization_rate": 0.5
|
||||
},
|
||||
"jobs": {
|
||||
"total": 100,
|
||||
"active": 5,
|
||||
"completed": 90,
|
||||
"avg_duration": 120
|
||||
},
|
||||
"users": {
|
||||
"total": 50
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Test-Endpunkt
|
||||
|
||||
### API-Test
|
||||
|
||||
**Endpunkt:** `GET /api/test`
|
||||
|
||||
**Beschreibung:** Testet, ob die API funktioniert.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "MYP Backend API funktioniert!"
|
||||
}
|
||||
```
|
||||
|
||||
## Fehlercodes
|
||||
|
||||
| Statuscode | Beschreibung |
|
||||
|------------|-----------------------------|
|
||||
| 200 | OK - Anfrage erfolgreich |
|
||||
| 201 | Created - Ressource erstellt |
|
||||
| 400 | Bad Request - Ungültige Anfrage |
|
||||
| 401 | Unauthorized - Authentifizierung erforderlich |
|
||||
| 403 | Forbidden - Unzureichende Rechte |
|
||||
| 404 | Not Found - Ressource nicht gefunden |
|
||||
| 500 | Internal Server Error - Serverfehler |
|
||||
230
backend/docs/COMMON_ERRORS.md
Normal file
230
backend/docs/COMMON_ERRORS.md
Normal file
@@ -0,0 +1,230 @@
|
||||
# Häufige Fehler und Lösungen
|
||||
|
||||
Dieses Dokument enthält häufig auftretende Probleme bei der Einrichtung und Nutzung von MYP im Kiosk-Modus und deren Lösungen.
|
||||
|
||||
## Installationsprobleme
|
||||
|
||||
### Fehler: "Paket nicht gefunden"
|
||||
|
||||
**Problem**: Beim Ausführen von `apt install` werden Pakete nicht gefunden.
|
||||
|
||||
**Lösung**:
|
||||
1. Führe zuerst `sudo apt update` aus, um die Paketlisten zu aktualisieren
|
||||
2. Stelle sicher, dass eine Internetverbindung besteht
|
||||
3. Bei älteren Raspberry Pi OS Versionen ggf. Repository hinzufügen:
|
||||
```bash
|
||||
sudo apt-add-repository universe
|
||||
sudo apt update
|
||||
```
|
||||
|
||||
### Fehler: "Permission denied" beim Kopieren nach /opt/myp
|
||||
|
||||
**Problem**: Beim Kopieren der Dateien nach /opt/myp wird ein Permission-Fehler angezeigt.
|
||||
|
||||
**Lösung**:
|
||||
1. Stelle sicher, dass du die Befehle in der richtigen Reihenfolge ausführst:
|
||||
```bash
|
||||
sudo mkdir -p /opt/myp
|
||||
sudo chown $USER:$USER /opt/myp
|
||||
```
|
||||
2. Falls das nicht hilft, führe den Kopierbefehl mit sudo aus:
|
||||
```bash
|
||||
sudo cp -r ./myp/* /opt/myp/
|
||||
sudo chown -R $USER:$USER /opt/myp/
|
||||
```
|
||||
|
||||
## Flask-Backend Probleme
|
||||
|
||||
### Fehler: "MYP-Dienst startet nicht"
|
||||
|
||||
**Problem**: Der systemd-Dienst für das Flask-Backend startet nicht.
|
||||
|
||||
**Lösung**:
|
||||
1. Überprüfe den Status des Dienstes:
|
||||
```bash
|
||||
sudo systemctl status myp.service
|
||||
```
|
||||
2. Schau in die Logs:
|
||||
```bash
|
||||
sudo journalctl -u myp.service -n 50
|
||||
```
|
||||
3. Häufige Ursachen:
|
||||
- Falscher Pfad in myp.service: Überprüfe WorkingDirectory und ExecStart
|
||||
- Python-Umgebung nicht korrekt: Überprüfe, ob die .venv-Umgebung existiert
|
||||
- Abhängigkeiten fehlen: Führe `pip install -r requirements.txt` aus
|
||||
|
||||
### Fehler: "ModuleNotFoundError: No module named X"
|
||||
|
||||
**Problem**: Beim Start der Flask-App wird ein Python-Modul nicht gefunden.
|
||||
|
||||
**Lösung**:
|
||||
1. Aktiviere die virtuelle Umgebung und installiere das fehlende Paket:
|
||||
```bash
|
||||
cd /opt/myp
|
||||
source .venv/bin/activate
|
||||
pip install <fehlende_module>
|
||||
```
|
||||
2. Überprüfe requirements.txt und installiere alle Abhängigkeiten:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Fehler: "Address already in use"
|
||||
|
||||
**Problem**: Flask kann nicht starten, weil Port 5000 bereits verwendet wird.
|
||||
|
||||
**Lösung**:
|
||||
1. Finde den Prozess, der Port 5000 verwendet:
|
||||
```bash
|
||||
sudo lsof -i:5000
|
||||
```
|
||||
2. Beende den Prozess:
|
||||
```bash
|
||||
sudo kill <PID>
|
||||
```
|
||||
3. Falls nötig, ändere den Port in app.py:
|
||||
```python
|
||||
app.run(host="0.0.0.0", port=5001, debug=True)
|
||||
```
|
||||
(Und passe auch die URL im kiosk.sh an)
|
||||
|
||||
## Chromium Kiosk-Modus Probleme
|
||||
|
||||
### Fehler: "Chromium startet nicht im Kiosk-Modus"
|
||||
|
||||
**Problem**: Der Browser startet nicht automatisch oder nicht im Vollbildmodus.
|
||||
|
||||
**Lösung**:
|
||||
1. Überprüfe den Status des User-Services:
|
||||
```bash
|
||||
systemctl --user status kiosk.service
|
||||
```
|
||||
2. Führe kiosk.sh manuell aus, um Fehlermeldungen zu sehen:
|
||||
```bash
|
||||
/home/pi/kiosk.sh
|
||||
```
|
||||
3. Prüfe, ob die notwendigen Pakete installiert sind:
|
||||
```bash
|
||||
sudo apt install --reinstall chromium-browser unclutter
|
||||
```
|
||||
|
||||
### Fehler: "Chromium zeigt Fehlerdialoge statt der MYP-Oberfläche"
|
||||
|
||||
**Problem**: Der Browser zeigt Crash-Dialoge oder Warnungen an.
|
||||
|
||||
**Lösung**:
|
||||
1. Lösche die Chromium-Einstellungen und starte neu:
|
||||
```bash
|
||||
rm -rf ~/.config/chromium/
|
||||
```
|
||||
2. Füge zusätzliche Parameter zu chromium-browser in kiosk.sh hinzu:
|
||||
```bash
|
||||
chromium-browser --kiosk --noerrdialogs --disable-infobars --disable-session-crashed-bubble \
|
||||
--disable-features=DialMediaRouteProvider --window-position=0,0 \
|
||||
--app=http://localhost:5000/ &
|
||||
```
|
||||
|
||||
### Fehler: "Chromium öffnet sich, aber zeigt nicht die MYP-Seite"
|
||||
|
||||
**Problem**: Der Browser startet, aber die Anwendung wird nicht angezeigt.
|
||||
|
||||
**Lösung**:
|
||||
1. Überprüfe, ob der Flask-Dienst läuft:
|
||||
```bash
|
||||
systemctl status myp.service
|
||||
```
|
||||
2. Teste, ob die Anwendung im Browser erreichbar ist:
|
||||
```bash
|
||||
curl http://localhost:5000/
|
||||
```
|
||||
3. Prüfe, ob Chromium mit der richtigen URL startet:
|
||||
```bash
|
||||
# In kiosk.sh
|
||||
chromium-browser --kiosk --noerrdialogs --disable-infobars \
|
||||
--window-position=0,0 --app=http://localhost:5000/ &
|
||||
```
|
||||
|
||||
## Watchdog-Probleme
|
||||
|
||||
### Fehler: "Watchdog-Script funktioniert nicht"
|
||||
|
||||
**Problem**: Der Watchdog-Cronjob scheint nicht zu funktionieren.
|
||||
|
||||
**Lösung**:
|
||||
1. Überprüfe, ob der Cron-Job eingerichtet ist:
|
||||
```bash
|
||||
crontab -l
|
||||
```
|
||||
2. Prüfe die Berechtigungen des Watchdog-Scripts:
|
||||
```bash
|
||||
chmod +x /home/pi/watchdog.sh
|
||||
```
|
||||
3. Führe das Script manuell aus und prüfe auf Fehler:
|
||||
```bash
|
||||
/home/pi/watchdog.sh
|
||||
```
|
||||
4. Überprüfe die Logdatei:
|
||||
```bash
|
||||
cat /home/pi/myp-watchdog.log
|
||||
```
|
||||
|
||||
### Fehler: "Watchdog kann systemctl nicht ausführen"
|
||||
|
||||
**Problem**: Der Watchdog kann systemctl-Befehle nicht ausführen.
|
||||
|
||||
**Lösung**:
|
||||
1. Erlaubnis für den pi-Benutzer zum Ausführen von systemctl hinzufügen:
|
||||
```bash
|
||||
echo "pi ALL=NOPASSWD: /bin/systemctl restart myp.service" | sudo tee /etc/sudoers.d/myp-watchdog
|
||||
```
|
||||
|
||||
## Allgemeine Probleme
|
||||
|
||||
### Fehler: "Bildschirm wird nach einiger Zeit schwarz"
|
||||
|
||||
**Problem**: Trotz Konfiguration schaltet sich der Bildschirm nach einiger Zeit aus.
|
||||
|
||||
**Lösung**:
|
||||
1. Stelle sicher, dass die xset-Befehle in kiosk.sh korrekt ausgeführt werden:
|
||||
```bash
|
||||
xset s off
|
||||
xset s noblank
|
||||
xset -dpms
|
||||
```
|
||||
2. Aktualisiere die Autostart-Datei:
|
||||
```bash
|
||||
sudo nano /etc/xdg/lxsession/LXDE-pi/autostart
|
||||
```
|
||||
Füge folgende Zeilen hinzu:
|
||||
```
|
||||
@xset s off
|
||||
@xset -dpms
|
||||
@xset s noblank
|
||||
```
|
||||
3. Verwende ein Tool wie Caffeine:
|
||||
```bash
|
||||
sudo apt install caffeine
|
||||
```
|
||||
|
||||
### Fehler: "System bootet nicht automatisch in den Kiosk-Modus"
|
||||
|
||||
**Problem**: Der automatische Start des Kiosk-Modus funktioniert nicht.
|
||||
|
||||
**Lösung**:
|
||||
1. Überprüfe, ob der automatische Login aktiviert ist:
|
||||
```bash
|
||||
sudo raspi-config
|
||||
# 1 System Options → S5 Boot/Auto Login → B4 Desktop Autologin
|
||||
```
|
||||
2. Stelle sicher, dass der User-Service aktiviert ist:
|
||||
```bash
|
||||
systemctl --user enable kiosk.service
|
||||
```
|
||||
3. Aktiviere Linger für den pi-Benutzer:
|
||||
```bash
|
||||
sudo loginctl enable-linger pi
|
||||
```
|
||||
4. Reboote das System und überprüfe den Status der Dienste:
|
||||
```bash
|
||||
sudo reboot
|
||||
```
|
||||
246
backend/docs/KIOSK-SETUP.md
Normal file
246
backend/docs/KIOSK-SETUP.md
Normal file
@@ -0,0 +1,246 @@
|
||||
# MYP im Kiosk-Modus
|
||||
|
||||
Diese Anleitung beschreibt, wie MYP (Manage Your Printer) auf einem Raspberry Pi 4 im Kiosk-Modus eingerichtet wird, sodass das System beim Booten automatisch startet.
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
- Raspberry Pi 4 (oder kompatibel) mit Raspbian/Raspberry Pi OS
|
||||
- Internetverbindung für die Installation (nach der Installation wird keine Verbindung mehr benötigt)
|
||||
- Bildschirm, Tastatur und Maus für die Einrichtung
|
||||
|
||||
## Komponenten des Kiosk-Modus
|
||||
|
||||
Die Kiosk-Einrichtung besteht aus mehreren Komponenten:
|
||||
|
||||
1. **Flask-Backend-Dienst**: Systemd-Service zum Starten der MYP-Anwendung
|
||||
2. **Chromium im Kiosk-Modus**: Browserinstanz, die das Dashboard anzeigt
|
||||
3. **Watchdog**: Überwacht den Browser und das Backend, startet bei Bedarf neu
|
||||
|
||||
## Automatische Installation
|
||||
|
||||
Für die automatische Installation kann das mitgelieferte Setup-Script verwendet werden:
|
||||
|
||||
```bash
|
||||
chmod +x setup.sh
|
||||
./setup.sh
|
||||
```
|
||||
|
||||
Dieses Script führt alle notwendigen Schritte aus:
|
||||
- Installation der benötigten Pakete
|
||||
- Kopieren der MYP-Anwendung nach `/opt/myp`
|
||||
- Einrichtung der Python-Umgebung und Installation der Abhängigkeiten
|
||||
- Konfiguration der Systemd-Dienste
|
||||
- Einrichtung des Kiosk-Modus
|
||||
- Einrichtung des Watchdogs
|
||||
|
||||
Nach der Ausführung des Scripts muss noch der automatische Login aktiviert werden:
|
||||
```bash
|
||||
sudo raspi-config
|
||||
# 1 System Options → S5 Boot/Auto Login → B4 Desktop Autologin
|
||||
```
|
||||
|
||||
## Manuelle Installation
|
||||
|
||||
Falls eine manuelle Installation bevorzugt wird, können die folgenden Schritte ausgeführt werden:
|
||||
|
||||
### 1. Pakete installieren
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y python3 python3-pip python3-venv chromium-browser \
|
||||
unclutter xdotool xscreensaver git
|
||||
```
|
||||
|
||||
### 2. MYP nach /opt/myp kopieren
|
||||
|
||||
```bash
|
||||
sudo mkdir -p /opt/myp
|
||||
sudo chown $USER:$USER /opt/myp
|
||||
cp -r ./myp/* /opt/myp
|
||||
cd /opt/myp
|
||||
```
|
||||
|
||||
### 3. Python-Umgebung und Abhängigkeiten einrichten
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 4. Systemd-Dienst für das Flask-Backend
|
||||
|
||||
Datei erstellen: `/etc/systemd/system/myp.service`
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=MYP Flask Backend
|
||||
After=network-online.target
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
User=pi
|
||||
WorkingDirectory=/opt/myp
|
||||
ExecStart=/opt/myp/.venv/bin/python /opt/myp/app.py
|
||||
Restart=always
|
||||
Environment=PYTHONUNBUFFERED=1
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
Dienst aktivieren:
|
||||
|
||||
```bash
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable --now myp.service
|
||||
```
|
||||
|
||||
### 5. Kiosk-Script einrichten
|
||||
|
||||
Datei erstellen: `/home/pi/kiosk.sh`
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Bildschirm-Blanking verhindern
|
||||
xset s off
|
||||
xset s noblank
|
||||
xset -dpms
|
||||
|
||||
# Mauszeiger ausblenden
|
||||
unclutter -idle 0.5 -root &
|
||||
|
||||
# Chromium-Crash-Dialoge unterdrücken
|
||||
sed -i 's/"exited_cleanly":false/"exited_cleanly":true/' \
|
||||
"$HOME/.config/chromium/Default/Preferences" 2>/dev/null || true
|
||||
sed -i 's/"exit_type":"Crashed"/"exit_type":"Normal"/' \
|
||||
"$HOME/.config/chromium/Default/Preferences" 2>/dev/null || true
|
||||
|
||||
# Browser starten
|
||||
chromium-browser --kiosk --noerrdialogs --disable-infobars \
|
||||
--window-position=0,0 --app=http://localhost:5000/ &
|
||||
```
|
||||
|
||||
Ausführbar machen:
|
||||
|
||||
```bash
|
||||
chmod +x /home/pi/kiosk.sh
|
||||
```
|
||||
|
||||
### 6. Systemd-User-Dienst für den Browser
|
||||
|
||||
Verzeichnis erstellen:
|
||||
|
||||
```bash
|
||||
mkdir -p /home/pi/.config/systemd/user
|
||||
```
|
||||
|
||||
Datei erstellen: `/home/pi/.config/systemd/user/kiosk.service`
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Chromium Kiosk
|
||||
PartOf=graphical-session.target
|
||||
|
||||
[Service]
|
||||
Type=forking
|
||||
ExecStart=/home/pi/kiosk.sh
|
||||
Restart=on-abort
|
||||
|
||||
[Install]
|
||||
WantedBy=xsession.target
|
||||
```
|
||||
|
||||
Dienst aktivieren:
|
||||
|
||||
```bash
|
||||
systemctl --user daemon-reload
|
||||
systemctl --user enable kiosk.service
|
||||
sudo loginctl enable-linger pi
|
||||
```
|
||||
|
||||
### 7. Watchdog einrichten
|
||||
|
||||
Datei erstellen: `/home/pi/watchdog.sh`
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
# MYP Watchdog für Chromium Browser
|
||||
|
||||
# Funktion zum Loggen von Nachrichten
|
||||
log() {
|
||||
echo "$(date '+%Y-%m-%d %H:%M:%S') - $1" >> /home/pi/myp-watchdog.log
|
||||
}
|
||||
|
||||
# Prüfen, ob Chromium läuft
|
||||
if ! pgrep -x "chromium-browse" > /dev/null; then
|
||||
log "Chromium nicht gefunden - starte neu"
|
||||
|
||||
# Alle eventuell noch vorhandenen Chromium-Prozesse beenden
|
||||
pkill -f chromium || true
|
||||
|
||||
# Warten bis alle Prozesse beendet sind
|
||||
sleep 2
|
||||
|
||||
# Kiosk-Script neu starten
|
||||
/home/pi/kiosk.sh
|
||||
|
||||
log "Chromium neugestartet"
|
||||
fi
|
||||
|
||||
# Prüfen, ob MYP Flask-Dienst läuft
|
||||
if ! systemctl is-active --quiet myp.service; then
|
||||
log "MYP Flask-Dienst ist nicht aktiv - starte neu"
|
||||
|
||||
# Dienst neustarten
|
||||
sudo systemctl restart myp.service
|
||||
|
||||
log "MYP Flask-Dienst neugestartet"
|
||||
fi
|
||||
|
||||
exit 0
|
||||
```
|
||||
|
||||
Ausführbar machen und Cron-Job einrichten:
|
||||
|
||||
```bash
|
||||
chmod +x /home/pi/watchdog.sh
|
||||
(crontab -l 2>/dev/null || echo "") | grep -v "watchdog.sh" | { cat; echo "*/5 * * * * /home/pi/watchdog.sh > /dev/null 2>&1"; } | crontab -
|
||||
```
|
||||
|
||||
### 8. Automatischen Desktop-Login einschalten
|
||||
|
||||
```bash
|
||||
sudo raspi-config
|
||||
# 1 System Options → S5 Boot/Auto Login → B4 Desktop Autologin
|
||||
```
|
||||
|
||||
### 9. Bildschirm nie ausschalten
|
||||
|
||||
```bash
|
||||
sudo sed -i 's/#BLANK_TIME=.*/BLANK_TIME=0/' /etc/xdg/lxsession/LXDE-pi/autostart
|
||||
```
|
||||
|
||||
## Ablauf beim Booten
|
||||
|
||||
1. Der Raspberry Pi startet und fährt bis zum Multi-User-Target hoch
|
||||
2. `myp.service` wird gestartet und das Flask-Backend sowie der Plug-Scheduler laufen
|
||||
3. LightDM startet und meldet den Benutzer `pi` automatisch an
|
||||
4. Nach dem Anmelden wird der User-Scope geladen und `kiosk.service` gestartet
|
||||
5. `kiosk.sh` startet Chromium im Kiosk-Modus und öffnet die MYP-Oberfläche
|
||||
6. Der Watchdog-Cron-Job überwacht alle 5 Minuten, ob alles läuft
|
||||
|
||||
## Fehlerbehebung
|
||||
|
||||
- **MYP startet nicht**: `systemctl status myp.service` zeigt den Status des Dienstes
|
||||
- **Browser startet nicht**: `systemctl --user status kiosk.service` zeigt den Status des Kiosk-Dienstes
|
||||
- **Watchdog-Logs**: In `/home/pi/myp-watchdog.log` werden Probleme und Neustarts protokolliert
|
||||
|
||||
## Anpassung für andere Benutzer
|
||||
|
||||
Falls ein anderer Benutzer als `pi` verwendet wird, müssen folgende Anpassungen vorgenommen werden:
|
||||
|
||||
1. In `myp.service`: `User=` auf den entsprechenden Benutzer ändern
|
||||
2. Pfade in `kiosk.sh` und `kiosk.service` anpassen
|
||||
3. `loginctl enable-linger` für den entsprechenden Benutzer aktivieren
|
||||
@@ -1,213 +0,0 @@
|
||||
# MYP - Projektdokumentation für das IHK-Abschlussprojekt
|
||||
|
||||
## Projektübersicht
|
||||
|
||||
**Projektname:** MYP (Manage Your Printer)
|
||||
**Projekttyp:** IHK-Abschlussprojekt für Fachinformatiker für digitale Vernetzung
|
||||
**Zeitraum:** [Dein Projektzeitraum]
|
||||
**Team:** 2 Personen (Frontend- und Backend-Entwicklung)
|
||||
|
||||
## Projektziel
|
||||
|
||||
Das Ziel des Projektes ist die Entwicklung einer Reservierungs- und Steuerungsplattform für 3D-Drucker, die es Benutzern ermöglicht, Drucker zu reservieren und deren Stromversorgung automatisch über WLAN-Steckdosen (Tapo P115) zu steuern. Die Plattform soll eine einfache Verwaltung der Drucker und ihrer Auslastung bieten sowie den Stromverbrauch optimieren, indem Drucker nur während aktiver Reservierungen mit Strom versorgt werden.
|
||||
|
||||
## Aufgabenbeschreibung
|
||||
|
||||
Als Fachinformatiker für digitale Vernetzung besteht meine Aufgabe in der Entwicklung des Backend-Systems, das folgende Funktionen bereitstellt:
|
||||
|
||||
1. **API-Backend für das Frontend**: Entwicklung einer RESTful API, die mit dem Frontend kommuniziert und alle notwendigen Daten bereitstellt.
|
||||
|
||||
2. **Authentifizierungssystem**: Integration einer OAuth-Authentifizierung über GitHub, um Benutzer zu identifizieren und Zugriffskontrolle zu gewährleisten.
|
||||
|
||||
3. **Datenbankverwaltung**: Erstellung und Verwaltung der Datenbankmodelle für Benutzer, Drucker und Reservierungen.
|
||||
|
||||
4. **Steckdosensteuerung**: Implementierung einer Schnittstelle zu Tapo P115 WLAN-Steckdosen, um die Stromversorgung der Drucker basierend auf Reservierungen zu steuern.
|
||||
|
||||
5. **Automatisierung**: Entwicklung von Mechanismen zur automatischen Überwachung von Reservierungen und Steuerung der Steckdosen.
|
||||
|
||||
6. **Sicherheit**: Implementierung von Sicherheitsmaßnahmen zum Schutz der Anwendung und der Daten.
|
||||
|
||||
7. **Dokumentation**: Erstellung einer umfassenden Dokumentation für Entwicklung, Installation und Nutzung des Systems.
|
||||
|
||||
## Technische Umsetzung
|
||||
|
||||
### Backend (Mein Verantwortungsbereich)
|
||||
|
||||
#### Verwendete Technologien
|
||||
|
||||
- **Programmiersprache**: Python 3.11
|
||||
- **Web-Framework**: Flask 2.3.3
|
||||
- **Datenbank-ORM**: SQLAlchemy 3.1.1
|
||||
- **Datenbank**: SQLite (für Entwicklung), erweiterbar auf PostgreSQL für Produktion
|
||||
- **Authentifizierung**: Authlib für GitHub OAuth
|
||||
- **Steckdosen-Steuerung**: Tapo Python Library
|
||||
- **Container-Technologie**: Docker und Docker Compose
|
||||
|
||||
#### Architektur
|
||||
|
||||
Die Backend-Anwendung folgt einer klassischen dreischichtigen Architektur:
|
||||
|
||||
1. **Datenmodell-Schicht**: SQLAlchemy ORM-Modelle für Benutzer, Sessions, Drucker und Druckaufträge
|
||||
2. **Business-Logic-Schicht**: Implementierung der Geschäftslogik für Reservierungsverwaltung und Steckdosensteuerung
|
||||
3. **API-Schicht**: RESTful API-Endpunkte, die vom Frontend konsumiert werden
|
||||
|
||||
Zusätzlich wurden folgende Features implementiert:
|
||||
|
||||
- **OAuth-Authentifizierung**: Implementierung einer sicheren Authentifizierung über GitHub
|
||||
- **Session-Management**: Server-seitige Session-Verwaltung für Benutzerauthentifizierung
|
||||
- **Steckdosensteuerung**: Asynchrone Steuerung der Tapo P115 WLAN-Steckdosen
|
||||
- **CLI-Befehle**: Flask CLI-Befehle für automatisierte Aufgaben wie die Überprüfung abgelaufener Reservierungen
|
||||
|
||||
#### Datenmodell
|
||||
|
||||
Das Datenmodell besteht aus vier Hauptentitäten:
|
||||
|
||||
1. **User**: Benutzer mit GitHub-Authentifizierung und Rollenverwaltung
|
||||
2. **Session**: Sitzungsdaten für die Authentifizierung
|
||||
3. **Printer**: Drucker mit Status und IP-Adresse der zugehörigen Steckdose
|
||||
4. **PrintJob**: Reservierungen mit Start- und Endzeit, Dauer und Status
|
||||
|
||||
#### API-Endpunkte
|
||||
|
||||
Die API wurde speziell entwickelt, um nahtlos mit dem bestehenden Frontend zusammenzuarbeiten. Sie bietet Endpunkte für:
|
||||
|
||||
- Authentifizierung und Benutzerverwaltung
|
||||
- Druckerverwaltung
|
||||
- Reservierungsverwaltung (Erstellen, Abbrechen, Verlängern)
|
||||
- Statusinformationen wie verbleibende Zeit
|
||||
|
||||
#### Steckdosensteuerung
|
||||
|
||||
Die Steuerung der Tapo P115 WLAN-Steckdosen erfolgt über die Tapo Python Library. Das System:
|
||||
|
||||
- Schaltet Steckdosen bei Erstellung einer Reservierung ein
|
||||
- Schaltet Steckdosen bei Abbruch oder Beendigung einer Reservierung aus
|
||||
- Überprüft regelmäßig abgelaufene Reservierungen und schaltet die entsprechenden Steckdosen aus
|
||||
|
||||
#### Automatisierung
|
||||
|
||||
Das System implementiert mehrere Automatisierungsmechanismen:
|
||||
|
||||
- **Automatische Steckdosensteuerung**: Ein- und Ausschalten der Steckdosen basierend auf Reservierungsstatus
|
||||
- **Job-Überprüfung**: CLI-Befehl `flask check-jobs` zur regelmäßigen Überprüfung abgelaufener Reservierungen
|
||||
- **Logging**: Automatische Protokollierung aller Aktionen zur Fehlerdiagnose
|
||||
|
||||
### Frontend (Verantwortungsbereich des Teampartners)
|
||||
|
||||
Das Frontend wurde von meinem Teampartner entwickelt und besteht aus:
|
||||
|
||||
- Next.js-Anwendung mit React-Komponenten
|
||||
- Tailwind CSS für das Styling
|
||||
- Serverless Functions für API-Integrationen
|
||||
- Responsive Design für Desktop- und Mobile-Nutzung
|
||||
|
||||
## Projektergebnisse
|
||||
|
||||
Das Projekt hat erfolgreich eine funktionsfähige Reservierungs- und Steuerungsplattform für 3D-Drucker geschaffen, die es Benutzern ermöglicht:
|
||||
|
||||
1. Sich über GitHub zu authentifizieren
|
||||
2. Verfügbare Drucker zu sehen und zu reservieren
|
||||
3. Ihre Reservierungen zu verwalten (verlängern, abbrechen, kommentieren)
|
||||
4. Als Administrator Drucker und Benutzer zu verwalten
|
||||
|
||||
Technische Errungenschaften:
|
||||
|
||||
1. Nahtlose Integration mit dem Frontend
|
||||
2. Erfolgreiche Implementierung der Steckdosensteuerung
|
||||
3. Sichere Authentifizierung über GitHub OAuth
|
||||
4. Optimierte Stromnutzung durch automatische Steckdosensteuerung
|
||||
|
||||
## Herausforderungen und Lösungen
|
||||
|
||||
### Herausforderung 1: GitHub OAuth-Integration
|
||||
|
||||
Die Integration der GitHub-Authentifizierung, insbesondere mit GitHub Enterprise, erforderte eine sorgfältige Konfiguration der OAuth-Einstellungen und URL-Anpassungen.
|
||||
|
||||
**Lösung:** Implementierung mit Authlib und anpassbaren Konfigurationsoptionen für verschiedene GitHub-Instanzen.
|
||||
|
||||
### Herausforderung 2: Tapo P115 Steuerung
|
||||
|
||||
Die Kommunikation mit den Tapo P115 WLAN-Steckdosen erforderte eine zuverlässige und asynchrone Implementierung.
|
||||
|
||||
**Lösung:** Verwendung der Tapo Python Library mit asynchronem Handling und robusten Fehlerbehandlungsmechanismen.
|
||||
|
||||
### Herausforderung 3: Kompatibilität mit bestehendem Frontend
|
||||
|
||||
Das Backend musste mit dem bereits entwickelten Frontend kompatibel sein, was eine genaue Anpassung der API-Endpunkte und Datenstrukturen erforderte.
|
||||
|
||||
**Lösung:** Sorgfältige Analyse des Frontend-Codes, um die erwarteten API-Strukturen zu verstehen und das Backend entsprechend zu implementieren.
|
||||
|
||||
### Herausforderung 4: Automatische Steckdosensteuerung
|
||||
|
||||
Die zuverlässige Steuerung der Steckdosen bei abgelaufenen Reservierungen war eine Herausforderung.
|
||||
|
||||
**Lösung:** Implementierung eines CLI-Befehls, der regelmäßig durch Cron-Jobs ausgeführt werden kann, um abgelaufene Reservierungen zu überprüfen.
|
||||
|
||||
## Fachliche Reflexion
|
||||
|
||||
Das Projekt erforderte ein breites Spektrum an Fähigkeiten aus dem Bereich der digitalen Vernetzung:
|
||||
|
||||
1. **Netzwerkkommunikation**: Implementierung der Kommunikation zwischen Backend, Frontend und WLAN-Steckdosen über verschiedene Protokolle.
|
||||
|
||||
2. **Systemintegration**: Integration verschiedener Systeme (GitHub OAuth, Datenbank, Tapo-Steckdosen) zu einer kohärenten Anwendung.
|
||||
|
||||
3. **API-Design**: Entwicklung einer RESTful API, die den Anforderungen des Frontends entspricht und zukunftssicher ist.
|
||||
|
||||
4. **Datenbankentwurf**: Erstellung eines optimierten Datenbankschemas für die Anwendung.
|
||||
|
||||
5. **Sicherheitskonzepte**: Implementierung von Sicherheitsmaßnahmen wie OAuth, Session-Management und Zugriffskontrollen.
|
||||
|
||||
6. **Automatisierung**: Entwicklung von Automatisierungsprozessen für die Steckdosensteuerung und Job-Überwachung.
|
||||
|
||||
Diese Aspekte entsprechen direkt den Kernkompetenzen des Berufsbildes "Fachinformatiker für digitale Vernetzung" und zeigen die praktische Anwendung dieser Fähigkeiten in einem realen Projekt.
|
||||
|
||||
## Ausblick und Weiterentwicklung
|
||||
|
||||
Das System bietet verschiedene Möglichkeiten zur Weiterentwicklung:
|
||||
|
||||
1. **Erweiterung der Steckdosenunterstützung**: Integration weiterer Smart-Home-Geräte neben Tapo P115.
|
||||
|
||||
2. **Benachrichtigungssystem**: Implementierung von E-Mail- oder Push-Benachrichtigungen für Reservierungserinnerungen.
|
||||
|
||||
3. **Erweiterte Statistiken**: Detailliertere Nutzungsstatistiken und Visualisierungen für Administratoren.
|
||||
|
||||
4. **Mobile App**: Entwicklung einer nativen mobilen App für iOS und Android.
|
||||
|
||||
5. **Verbesserte Automatisierung**: Integration mit weiteren Systemen wie 3D-Drucker-APIs für direktes Monitoring des Druckstatus.
|
||||
|
||||
## Fazit
|
||||
|
||||
Das MYP-Projekt zeigt erfolgreich, wie moderne Webtechnologien und IoT-Geräte kombiniert werden können, um eine praktische Lösung für die Verwaltung von 3D-Druckern zu schaffen.
|
||||
|
||||
Als angehender Fachinformatiker für digitale Vernetzung konnte ich meine Fähigkeiten in den Bereichen Programmierung, Systemintegration, Netzwerkkommunikation und Automatisierung anwenden und erweitern.
|
||||
|
||||
Die Zusammenarbeit im Team mit klarer Aufgabenteilung (Frontend/Backend) hat zu einem erfolgreichen Projektergebnis geführt, das die gestellten Anforderungen erfüllt und einen praktischen Nutzen bietet.
|
||||
|
||||
---
|
||||
|
||||
## Anhang
|
||||
|
||||
### Installation und Einrichtung
|
||||
|
||||
Detaillierte Anweisungen zur Installation und Einrichtung des Backend-Systems finden sich in der README.md-Datei.
|
||||
|
||||
### Wichtige Konfigurationsparameter
|
||||
|
||||
Die folgenden Umgebungsvariablen müssen konfiguriert werden:
|
||||
|
||||
- `SECRET_KEY`: Geheimer Schlüssel für die Session-Verschlüsselung
|
||||
- `DATABASE_URL`: URL zur Datenbank
|
||||
- `OAUTH_CLIENT_ID`: GitHub OAuth Client ID
|
||||
- `OAUTH_CLIENT_SECRET`: GitHub OAuth Client Secret
|
||||
- `GITHUB_API_BASE_URL`, `GITHUB_AUTHORIZE_URL`, `GITHUB_TOKEN_URL`: URLs für GitHub OAuth
|
||||
- `TAPO_USERNAME`: Benutzername für die Tapo-Steckdosen
|
||||
- `TAPO_PASSWORD`: Passwort für die Tapo-Steckdosen
|
||||
- `TAPO_DEVICES`: JSON-Objekt mit der Zuordnung von Drucker-IDs zu IP-Adressen
|
||||
|
||||
### Cron-Job-Einrichtung
|
||||
|
||||
Für die automatische Überprüfung abgelaufener Jobs kann folgender Cron-Job eingerichtet werden:
|
||||
|
||||
```
|
||||
*/5 * * * * cd /pfad/zum/projekt && /pfad/zur/venv/bin/flask check-jobs >> /pfad/zum/projekt/logs/cron.log 2>&1
|
||||
```
|
||||
@@ -1,189 +1,118 @@
|
||||
# MYP Backend-Steuerungsplattform
|
||||
# MYP - Manage Your Printer
|
||||
|
||||
Dies ist das Backend für das MYP (Manage Your Printer) Projekt, ein IHK-Abschlussprojekt für Fachinformatiker für digitale Vernetzung. Die Plattform ist mit Python und Flask implementiert und stellt eine RESTful API zur Verfügung, die es ermöglicht, 3D-Drucker zu verwalten, zu reservieren und über WLAN-Steckdosen (Tapo P115) zu steuern.
|
||||
Ein System zur Verwaltung und Steuerung von 3D-Druckern über TP-Link Tapo P110 Smart Plugs.
|
||||
|
||||
## Funktionen
|
||||
## Funktionsumfang
|
||||
|
||||
- Lokales Authentifizierungssystem (Offline-fähig)
|
||||
- Rollen-basierte Zugriffskontrolle (Admin/User/Guest)
|
||||
- Druckerverwaltung (Hinzufügen, Bearbeiten, Löschen)
|
||||
- Reservierungsverwaltung (Erstellen, Abbrechen, Verlängern)
|
||||
- Fernsteuerung von WLAN-Steckdosen (Tapo P115)
|
||||
- Statistikerfassung und -anzeige
|
||||
- RESTful API für die Kommunikation mit dem Frontend
|
||||
- Benutzer- und Rechteverwaltung (Admin/User)
|
||||
- Verwaltung von Druckern und Smart Plugs
|
||||
- Reservierungssystem für Drucker (Zeitplanung)
|
||||
- Automatisches Ein-/Ausschalten der Drucker über Smart Plugs
|
||||
- Statistikerfassung für Druckaufträge
|
||||
- **NEU**: Kiosk-Modus für automatischen Start auf Raspberry Pi
|
||||
|
||||
## Technologie-Stack
|
||||
## Systemvoraussetzungen
|
||||
|
||||
- **Python**: Programmiersprache
|
||||
- **Flask**: Web-Framework
|
||||
- **SQLite**: Integrierte Datenbank (kann für Produktion durch PostgreSQL ersetzt werden)
|
||||
- **PyP100**: Python-Bibliothek zur Steuerung der Tapo P115 WLAN-Steckdosen
|
||||
- **Gunicorn**: WSGI HTTP Server für die Produktionsumgebung
|
||||
- **Docker**: Containerisierung der Anwendung
|
||||
- Raspberry Pi 4 (oder kompatibel)
|
||||
- Python 3.11+
|
||||
- Internetzugang für die Installation (danach offline nutzbar)
|
||||
- TP-Link Tapo P110 Smart Plugs im lokalen Netzwerk
|
||||
|
||||
## Projekt-Struktur
|
||||
## Installation
|
||||
|
||||
- `app.py`: Hauptanwendungsdatei mit allen Routen und Modellen
|
||||
- `requirements.txt`: Liste aller Python-Abhängigkeiten
|
||||
- `Dockerfile`: Docker-Konfiguration
|
||||
- `docker-compose.yml`: Docker Compose Konfiguration für einfaches Deployment
|
||||
- `.env.example`: Beispiel für die Umgebungsvariablen
|
||||
- `logs/`: Logdateien (automatisch erstellt)
|
||||
- `instance/`: SQLite-Datenbank (automatisch erstellt)
|
||||
### Standardinstallation
|
||||
|
||||
## Installation und Ausführung
|
||||
1. Repository klonen oder Dateien auf den Raspberry Pi kopieren
|
||||
|
||||
### Lokal (Entwicklung)
|
||||
2. Abhängigkeiten installieren:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
1. Python 3.8 oder höher installieren
|
||||
2. Repository klonen
|
||||
3. Ins Projektverzeichnis wechseln
|
||||
4. Virtuelle Umgebung erstellen (optional, aber empfohlen)
|
||||
```
|
||||
python -m venv venv
|
||||
source venv/bin/activate # Unter Windows: venv\Scripts\activate
|
||||
```
|
||||
5. Abhängigkeiten installieren
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
6. `.env.example` nach `.env` kopieren und anpassen
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
7. Anwendung starten
|
||||
```
|
||||
python app.py
|
||||
```
|
||||
3. Anwendung starten:
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
Die Anwendung ist dann unter http://localhost:5000 erreichbar.
|
||||
Die Anwendung läuft dann unter http://localhost:5000 oder unter der IP-Adresse des Raspberry Pi.
|
||||
|
||||
### Mit Docker
|
||||
### Kiosk-Modus Installation
|
||||
|
||||
1. Docker und Docker Compose installieren
|
||||
2. Ins Projektverzeichnis wechseln
|
||||
3. `.env.example` nach `.env` kopieren und anpassen
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
4. Anwendung starten
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
Für den vollautomatischen Start im Kiosk-Modus (z.B. für IHK-Prüfungen):
|
||||
|
||||
Die Anwendung ist dann unter http://localhost:5000 erreichbar.
|
||||
```bash
|
||||
chmod +x setup.sh
|
||||
./setup.sh
|
||||
```
|
||||
|
||||
## API-Endpunkte
|
||||
Detaillierte Anweisungen finden sich in der [Kiosk-Setup Anleitung](KIOSK-SETUP.md).
|
||||
|
||||
## Erster Start
|
||||
|
||||
Beim ersten Start wird eine leere Datenbank angelegt. Es muss ein erster Administrator angelegt werden:
|
||||
|
||||
```
|
||||
POST /api/create-initial-admin
|
||||
```
|
||||
|
||||
Mit folgendem JSON-Body:
|
||||
```json
|
||||
{
|
||||
"email": "admin@example.com",
|
||||
"password": "sicheres-passwort",
|
||||
"name": "Administrator"
|
||||
}
|
||||
```
|
||||
|
||||
## API-Dokumentation
|
||||
|
||||
Die Anwendung stellt folgende REST-API-Endpunkte bereit:
|
||||
|
||||
### Authentifizierung
|
||||
|
||||
- `POST /auth/register`: Neuen Benutzer registrieren
|
||||
- `POST /auth/login`: Benutzer anmelden
|
||||
- `POST /auth/logout`: Abmelden und Session beenden
|
||||
- `POST /api/create-initial-admin`: Initialen Administrator erstellen
|
||||
- `GET /api/me`: Aktuelle Benutzerinformationen abrufen
|
||||
|
||||
### Benutzer
|
||||
|
||||
- `GET /api/users`: Liste aller Benutzer (Admin)
|
||||
- `GET /api/users/<id>`: Details zu einem Benutzer (Admin)
|
||||
- `PUT /api/users/<id>`: Benutzer aktualisieren (Admin)
|
||||
- `DELETE /api/users/<id>`: Benutzer löschen (Admin)
|
||||
- `POST /auth/register` - Neuen Benutzer registrieren
|
||||
- `POST /auth/login` - Anmelden (erstellt eine Session für 7 Tage)
|
||||
|
||||
### Drucker
|
||||
|
||||
- `GET /api/printers`: Liste aller Drucker
|
||||
- `POST /api/printers`: Drucker hinzufügen (Admin)
|
||||
- `GET /api/printers/<id>`: Details zu einem Drucker
|
||||
- `PUT /api/printers/<id>`: Drucker aktualisieren (Admin)
|
||||
- `DELETE /api/printers/<id>`: Drucker löschen (Admin)
|
||||
- `GET /api/printers` - Alle Drucker auflisten
|
||||
- `GET /api/printers/<printerId>` - Einzelnen Drucker abrufen
|
||||
- `POST /api/printers` - Neuen Drucker anlegen
|
||||
- `DELETE /api/printers/<printerId>` - Drucker löschen
|
||||
|
||||
### Druckaufträge
|
||||
### Jobs/Reservierungen
|
||||
|
||||
- `GET /api/jobs`: Liste aller Druckaufträge (Admin) oder eigener Druckaufträge (Benutzer)
|
||||
- `POST /api/jobs`: Druckauftrag erstellen
|
||||
- `GET /api/jobs/<id>`: Details zu einem Druckauftrag
|
||||
- `POST /api/jobs/<id>/abort`: Druckauftrag abbrechen
|
||||
- `POST /api/jobs/<id>/finish`: Druckauftrag vorzeitig beenden
|
||||
- `POST /api/jobs/<id>/extend`: Druckauftrag verlängern
|
||||
- `PUT /api/jobs/<id>/comments`: Kommentare aktualisieren
|
||||
- `GET /api/job/<id>/remaining-time`: Verbleibende Zeit für einen aktiven Druckauftrag
|
||||
- `GET /api/jobs` - Alle Reservierungen abrufen
|
||||
- `POST /api/jobs` - Neue Reservierung anlegen
|
||||
- `GET /api/jobs/<jobId>` - Reservierungsdetails abrufen
|
||||
- `POST /api/jobs/<jobId>/finish` - Job beenden (Plug ausschalten)
|
||||
- `POST /api/jobs/<jobId>/abort` - Job abbrechen (Plug ausschalten)
|
||||
- `POST /api/jobs/<jobId>/extend` - Endzeit verschieben
|
||||
- `GET /api/jobs/<jobId>/status` - Aktuellen Plug-Status abrufen
|
||||
- `GET /api/jobs/<jobId>/remaining-time` - Restzeit in Sekunden abrufen
|
||||
- `DELETE /api/jobs/<jobId>` - Job löschen
|
||||
|
||||
### Statistiken
|
||||
### Benutzer
|
||||
|
||||
- `GET /api/stats`: Statistiken zu Druckern, Aufträgen und Benutzern (Admin)
|
||||
- `GET /api/users` - Alle Benutzer auflisten (nur Admin)
|
||||
- `GET /api/users/<userId>` - Einzelnen Benutzer abrufen
|
||||
- `DELETE /api/users/<userId>` - Benutzer löschen (nur Admin)
|
||||
|
||||
## Datenmodell
|
||||
### Sonstiges
|
||||
|
||||
### Benutzer (User)
|
||||
- `GET /api/stats` - Globale Statistik (Druckzeit, etc.)
|
||||
- `GET /api/test` - Health-Check
|
||||
|
||||
- id (String UUID, Primary Key)
|
||||
- username (String, Unique)
|
||||
- password_hash (String)
|
||||
- display_name (String)
|
||||
- email (String, Unique)
|
||||
- role (String, 'admin', 'user' oder 'guest')
|
||||
## Sicherheitshinweise
|
||||
|
||||
### Session
|
||||
- Diese Anwendung speichert alle Zugangsdaten direkt im Code und in der Datenbank.
|
||||
- Die Anwendung sollte ausschließlich in einem geschützten, lokalen Netzwerk betrieben werden.
|
||||
- Es wird keine Verschlüsselung für die API-Kommunikation verwendet.
|
||||
|
||||
- id (String UUID, Primary Key)
|
||||
- user_id (String UUID, Foreign Key zu User)
|
||||
- expires_at (DateTime)
|
||||
## Wartung und Troubleshooting
|
||||
|
||||
### Drucker (Printer)
|
||||
- Die Logdatei `myp.log` enthält alle wichtigen Ereignisse und Fehler
|
||||
- Die Datenbank wird in `database/myp.db` gespeichert
|
||||
- Häufig auftretende Probleme und Lösungen finden sich in [COMMON_ERRORS.md](COMMON_ERRORS.md)
|
||||
- Zukünftige Entwicklungspläne sind in [ROADMAP.md](ROADMAP.md) dokumentiert
|
||||
|
||||
- id (String UUID, Primary Key)
|
||||
- name (String)
|
||||
- description (Text)
|
||||
- status (Integer, 0=available, 1=busy, 2=maintenance)
|
||||
- ip_address (String, IP-Adresse der Tapo-Steckdose)
|
||||
|
||||
### Druckauftrag (PrintJob)
|
||||
|
||||
- id (String UUID, Primary Key)
|
||||
- printer_id (String UUID, Foreign Key zu Printer)
|
||||
- user_id (String UUID, Foreign Key zu User)
|
||||
- start_at (DateTime)
|
||||
- duration_in_minutes (Integer)
|
||||
- comments (Text)
|
||||
- aborted (Boolean)
|
||||
- abort_reason (Text)
|
||||
|
||||
## Steckdosensteuerung
|
||||
|
||||
Die Anwendung steuert Tapo P115 WLAN-Steckdosen, um die Drucker basierend auf Reservierungen ein- und auszuschalten:
|
||||
|
||||
- Bei Erstellung eines Druckauftrags wird die Steckdose des zugehörigen Druckers automatisch eingeschaltet
|
||||
- Bei Abbruch oder vorzeitiger Beendigung eines Druckauftrags wird die Steckdose ausgeschaltet
|
||||
- Nach Ablauf der Reservierungszeit wird die Steckdose automatisch ausgeschaltet
|
||||
- Ein CLI-Befehl `flask check-jobs` überprüft regelmäßig abgelaufene Jobs und schaltet Steckdosen aus
|
||||
|
||||
## Sicherheit
|
||||
|
||||
- Die Anwendung verwendet ein lokales Authentifizierungssystem mit Passwort-Hashing
|
||||
- Sitzungsdaten werden in Server-Side-Sessions gespeichert
|
||||
- Zugriffskontrollen sind implementiert, um sicherzustellen, dass Benutzer nur auf ihre eigenen Daten zugreifen können
|
||||
- Admin-Benutzer haben Zugriff auf alle Daten und können Systemkonfigurationen ändern
|
||||
- Der erste registrierte Benutzer wird automatisch zum Administrator
|
||||
|
||||
## Logging
|
||||
|
||||
Die Anwendung protokolliert Aktivitäten in rotierenden Logdateien in einem `logs` Verzeichnis. Dies hilft bei der Fehlersuche und Überwachung der Anwendung im Betrieb.
|
||||
|
||||
## Umgebungsvariablen
|
||||
|
||||
Die folgenden Umgebungsvariablen müssen konfiguriert werden:
|
||||
|
||||
- `SECRET_KEY`: Geheimer Schlüssel für die Session-Verschlüsselung
|
||||
- `DATABASE_PATH`: Pfad zur Datenbank (Standard: SQLite-Datenbank im Instance-Verzeichnis)
|
||||
- `TAPO_USERNAME`: Benutzername für die Tapo-Steckdosen
|
||||
- `TAPO_PASSWORD`: Passwort für die Tapo-Steckdosen
|
||||
- `PRINTERS`: JSON-Objekt mit der Zuordnung von Drucker-Namen zu IP-Adressen der Steckdosen im Format: `{"Printer 1": {"ip": "192.168.1.100"}, "Printer 2": {"ip": "192.168.1.101"}, ...}`
|
||||
|
||||
## Automatisierung
|
||||
|
||||
Die Anwendung beinhaltet einen CLI-Befehl `flask check-jobs`, der regelmäßig ausgeführt werden sollte (z.B. als Cron-Job), um abgelaufene Druckaufträge zu überprüfen und die zugehörigen Steckdosen auszuschalten.
|
||||
|
||||
## Kompatibilität mit dem Frontend
|
||||
|
||||
Das Backend wurde speziell für die Kompatibilität mit dem bestehenden Frontend entwickelt, welches in `/frontend` zu finden ist. Die API-Endpunkte und Datenstrukturen sind so gestaltet, dass sie nahtlos mit dem Frontend zusammenarbeiten.
|
||||
|
||||
62
backend/docs/ROADMAP.md
Normal file
62
backend/docs/ROADMAP.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# MYP Entwicklungs-Roadmap
|
||||
|
||||
Dieses Dokument skizziert die geplanten Entwicklungsschritte für MYP (Manage Your Printer).
|
||||
|
||||
## Version 1.0 (aktuell)
|
||||
|
||||
- [x] Benutzer- und Rechteverwaltung (Admin/User)
|
||||
- [x] Verwaltung von Druckern und Smart Plugs
|
||||
- [x] Reservierungssystem für Drucker (Zeitplanung)
|
||||
- [x] Automatisches Ein-/Ausschalten der Drucker über Smart Plugs
|
||||
- [x] Grundlegende Statistikerfassung
|
||||
- [x] Kiosk-Modus für Raspberry Pi
|
||||
|
||||
## Version 1.1 (nächstes Release)
|
||||
|
||||
- [ ] Verbessertes Dashboard mit Echtzeit-Status aller Drucker
|
||||
- [ ] Optimierte Benutzeroberfläche für Touchscreen-Bedienung
|
||||
- [ ] Verbesserte Fehlerbehandlung und Selbstheilungsmechanismen
|
||||
- [ ] Unterstützung für verschiedene Sprachen (Internationalisierung)
|
||||
- [ ] Erweiterte Logging-Funktionalität
|
||||
|
||||
## Version 1.2 (mittelfristig)
|
||||
|
||||
- [ ] Unterstützung für weitere Smart-Plug-Typen (nicht nur TP-Link Tapo)
|
||||
- [ ] Telegram- oder E-Mail-Benachrichtigungen bei Job-Ende/Problemen
|
||||
- [ ] Verbesserte Statistik mit visuellen Darstellungen (Graphen, Charts)
|
||||
- [ ] Exportfunktion für Nutzungsdaten (CSV, PDF)
|
||||
- [ ] Einfache Nutzungsanleitungen direkt in der Web-Oberfläche
|
||||
|
||||
## Version 2.0 (langfristig)
|
||||
|
||||
- [ ] Direkte Integration mit OctoPrint für 3D-Drucker-Steuerung
|
||||
- [ ] Kamera-Integration zur visuellen Überwachung der Drucker
|
||||
- [ ] Materialverwaltung mit Bestandsführung
|
||||
- [ ] Kostenberechnung für Druckaufträge
|
||||
- [ ] Prognose der Energiekosten basierend auf Messwerten der P110-Plugs
|
||||
- [ ] Mobile App für iOS/Android
|
||||
|
||||
## Technische Schulden & Optimierungen
|
||||
|
||||
- [ ] Umstellung auf asynchrone API mit FastAPI
|
||||
- [ ] Frontend mit modernem Framework (Vue.js, React)
|
||||
- [ ] API-Dokumentation mit Swagger/OpenAPI
|
||||
- [ ] Verbessertes Datenbankschema für bessere Skalierbarkeit
|
||||
- [ ] Unit- und Integrationstests
|
||||
- [ ] Containerisierung mit Docker für einfachere Bereitstellung
|
||||
- [ ] Upgrade auf Python 3.12+ und neuere Abhängigkeiten
|
||||
|
||||
## Sicherheitsverbesserungen
|
||||
|
||||
- [ ] HTTPS-Unterstützung
|
||||
- [ ] Verbesserte Passwort-Richtlinien
|
||||
- [ ] 2-Faktor-Authentifizierung für Administratoren
|
||||
- [ ] Regelmäßige Sicherheits-Audits
|
||||
- [ ] Sichere Speicherung von Zugangsdaten (nicht im Code)
|
||||
|
||||
## Wartbarkeit
|
||||
|
||||
- [ ] Umfassendere Dokumentation für Entwickler
|
||||
- [ ] Code-Refactoring für bessere Lesbarkeit und Wartbarkeit
|
||||
- [ ] Aufteilen von app.py in mehrere Module
|
||||
- [ ] Verbessertes Fehlerhandling und Logging
|
||||
Reference in New Issue
Block a user