82 lines
3.0 KiB
Markdown
82 lines
3.0 KiB
Markdown
# CMBNet
|
|
|
|
Webanwendung für die Verwaltung von Straßen und Gruppen mit Kartendarstellung.
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
cd CMBNet
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
mkdir -p instance logs data migrations
|
|
flask --app cmbnet init-db
|
|
flask --app cmbnet run --debug --host 127.0.0.1 --port 5000
|
|
```
|
|
|
|
## Zugriff
|
|
|
|
Öffne http://127.0.0.1:5000 und wähle einen Mandanten (BV, RV, SV).
|
|
|
|
## Betrieb hinter einem Reverse-Proxy (URI-Prefix)
|
|
|
|
Die Anwendung kann unter einem beliebigen Pfad ausgeliefert werden, z. B.
|
|
`https://example.com/cmbnet/`. Dazu muss der Proxy den öffentlichen Prefix im
|
|
Header `X-Forwarded-Prefix` setzen:
|
|
|
|
```caddyfile
|
|
example.com {
|
|
redir /cmbnet /cmbnet/ 308
|
|
|
|
handle_path /cmbnet/* {
|
|
reverse_proxy 127.0.0.1:5000 {
|
|
header_up X-Forwarded-Prefix /cmbnet
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Die Middleware in `cmbnet/__init__.py` setzt daraus `SCRIPT_NAME`, sodass
|
|
`url_for` alle Links, Formularziele und statischen Dateien mit Prefix erzeugt.
|
|
Der Prefix wird außerdem als `CMBNET_BASE_URL` an JavaScript übergeben; AJAX-
|
|
und WebSocket-Aufrufe bilden ihre URLs damit korrekt. Eine vollständige
|
|
Beispielkonfiguration (auch für Proxys, die den Prefix nicht entfernen) steht
|
|
in `Caddyfile.example`.
|
|
|
|
Wichtig: Der Flask-Port sollte nur für den Reverse-Proxy erreichbar sein, damit
|
|
Clients den Header nicht selbst setzen können.
|
|
|
|
## WebSocket-Synchronisierung
|
|
|
|
Jeder Browser-Tab erzeugt eine Sitzungs-ID, die in `sessionStorage` gespeichert
|
|
wird und ein Neuladen übersteht. Nicht zustellbare Nachrichten mit Code >= 100
|
|
werden beim Broker pro `(Mandant, Account, Sitzungs-ID)` gepuffert und bei der
|
|
nächsten WebSocket-Verbindung mit derselben ID ausgeliefert.
|
|
|
|
Die beiden Zeitfenster lassen sich über Umgebungsvariablen konfigurieren:
|
|
|
|
- `CMBNET_WS_QUEUE_MAX_AGE_MINUTES` (Default `15`): Maximales Alter einer
|
|
Sitzungs-Queue. Ältere Queues werden verworfen; beim nächsten Reconnect wird
|
|
stattdessen eine Code-99-Nachricht mit Hinweis auf die zu lange Unterbrechung
|
|
zugestellt.
|
|
- `CMBNET_WS_GROUP_ONLINE_TIMEOUT_SECONDS` (Default `120`): Zeit ohne Code-2-
|
|
Lebenszeichen, nach der eine Gruppe von `online` auf `unterwegs` wechselt.
|
|
|
|
Die Sitzungs-Queues liegen im Arbeitsspeicher des Broker-Prozesses. Sie
|
|
überstehen damit WebSocket-Unterbrechungen und Seiten-Reloads, nicht aber einen
|
|
Neustart des Servers. Der mobile Client puffert zusätzlich ausgehende
|
|
fachliche Nachrichten kurzzeitig lokal und sendet sie nach erfolgreicher
|
|
Authentifizierung automatisch nach.
|
|
|
|
## Erste Einrichtung
|
|
|
|
Nach der Initialisierung der Datenbank müssen noch Mandanten und ein Admin-Account angelegt werden.
|
|
|
|
```bash
|
|
sqlite3 instance/cmbnet.sqlite3
|
|
INSERT INTO tenants (code, name) VALUES ('BV', 'Bezirk BV'), ('RV', 'Bezirk RV'), ('SV', 'Bezirk SV');
|
|
INSERT INTO accounts (tenant_id, name, password_hash, role) VALUES (2, 'admin', '...', 'Administrator');
|
|
```
|
|
|
|
Für den Passwort-Hash kann `python3 -c "from werkzeug.security import generate_password_hash; print(generate_password_hash('admin'))"` verwendet werden.
|