RepairCafeHilpoltstein/RepApp
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Tom Irgang 2023-04-25 14:32:45 +02:00
parent cdbc26834c
commit c061cad194
2 changed files with 48 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

97
docs/index.md
View file

@ -251,12 +251,10 @@ URL: /
Name: index Name: index
Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
Diese Seite zeigt eine Liste der zukünftigen Repair-Café Termine. Diese Seite zeigt eine Liste der zukünftigen Repair-Café Termine.
Sie enthält pro Repair-Café einen Knopf um ein Gerät für dieses Repair-Café anzumelden. Sie enthält pro Repair-Café einen Link um ein Gerät für dieses Repair-Café anzumelden.
#### Sicherheit
Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
### Gerät anmelden (S2) ### Gerät anmelden (S2)
@ -264,16 +262,14 @@ URL: cafe/int:cafe/
Name: register_device Name: register_device
Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
Diese Seite zeigt das Formular zum anmelden der Geräte. Diese Seite zeigt das Formular zum anmelden der Geräte.
Das Formular hat die Felder `eMail-Adresse`, `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild`, ein Kontrollkästchen `Folgetermin`, ein Kontrollkästchen `Informationen zur Reparaturabwicklung`, ein Kontrollkästchen `Datenschutz` und einen Knopf `Absenden` zum senden des Formulars. Das Formular hat die Felder `eMail-Adresse`, `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild`, ein Kontrollkästchen `Folgetermin`, ein Kontrollkästchen `Informationen zur Reparaturabwicklung`, ein Kontrollkästchen `Datenschutz` und einen Knopf `Absenden` zum senden des Formulars.
Das Repair-Café zu dem die Anmeldung gehört ist über eine ID in der URL der Seite festgelegt. Das Repair-Café zu dem die Anmeldung gehört ist über eine ID in der URL der Seite festgelegt.
Die eMail-Benachrichtigung and die Organisatoren und die Bestätigung an den Gast wird beim absenden des Formulars gesendet, falls die eMail Adresse zu einem bekannten Gast gehört. Falls die eMail Adresse zu einem bekannten Gast gehört, wird beim absenden des Formulars eine eMail-Benachrichtigung and die Organisatoren und Bestätigung an den Gast gesendet.
#### Sicherheit
Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
### Gast anmelden (S3) ### Gast anmelden (S3)
@ -281,16 +277,14 @@ URL: cafe/int:cafe/device/str:device_identifier/mail/str:mail/
Name: register_guest Name: register_guest
Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
Diese Seite zeigt das Formular zum anmelden eines neuen Gastes. Diese Seite zeigt das Formular zum anmelden eines neuen Gastes.
Das Formular hat die Felder `Name`, `Telefon`, `Wohnort` und einen Knopf `Absenden` zum senden des Formulars. Das Formular hat die Felder `Name`, `Telefon`, `Wohnort` und einen Knopf `Absenden` zum senden des Formulars.
Die eMail-Adresse und das Gerät zu dem die Gast-Kontaktdaten gehören ist über IDs in der URL der Seite festgelegt. Die eMail-Adresse und das Gerät zu dem die Gast-Kontaktdaten gehören ist über IDs in der URL der Seite festgelegt.
Die eMail-Benachrichtigung and die Organisatoren und die Bestätigung an den Gast wird beim absenden des Formulars gesendet. Beim absenden des Formulars eine eMail-Benachrichtigung and die Organisatoren und Bestätigung an den Gast gesendet.
#### Sicherheit
Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
### Anmeldung bestätigt (S7) ### Anmeldung bestätigt (S7)
@ -298,39 +292,37 @@ URL: cafe/int:cafe/device/str:device_identifier/confirm/
Name: register_device_final Name: register_device_final
Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
Die Seite Anmeldung bestätigt zeigt einen Hinweis dass die Anmeldung des Gerätes erfolgreich abgeschlossen wurde. Die Seite Anmeldung bestätigt zeigt einen Hinweis dass die Anmeldung des Gerätes erfolgreich abgeschlossen wurde.
Die Geräte ID ist in der URL der Seite festgelegt. Die Geräte ID ist in der URL der Seite festgelegt.
#### Sicherheit
Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
### Geräte Detailseite (S5) ### Geräte Detailseite (S5)
URL: device/str:device_identifier/ URL: device/str:device_identifier/
Name: view_device Name: view_device
Sicherheit: Diese Seite ist für alle Mitarbeiter und den Gast der das Gerät angemeldet hat erreichbar.
Die Geräte Detailseite zeigt die Informationen `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild` und `Folgetermin` an. Die Geräte Detailseite zeigt die Informationen `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild` und `Folgetermin` an.
Das Gerät ist über IDs in der URL der Seite festgelegt. Das Gerät ist über IDs in der URL der Seite festgelegt.
#### Sicherheit
Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
### Gast Detailseite (S6) ### Gast Detailseite (S6)
URL: guest/profile/
Name: guest_profile
Sicherheit: Die Seite enthält persönliche Daten und ist nur für den Gast zu dem sie gehört erreichbar.
Die Gast Detailseite hat die Felder `Name`, `eMail`, `Telefon` und `Wohnort` die mit den Angaben des Gastes ausgefüllt sind. Die Gast Detailseite hat die Felder `Name`, `eMail`, `Telefon` und `Wohnort` die mit den Angaben des Gastes ausgefüllt sind.
Weiter enthält die Seite einen Knopf `Aktualisieren` der das Formular absendet. Weiter enthält die Seite einen Knopf `Aktualisieren` der das Formular absendet.
Die Ansicht enthält auch eine Liste mit Links zu allen Geräten die der Gast angemeldet hat. Die Ansicht enthält auch eine Liste mit Links zu allen Geräten die der Gast angemeldet hat.
Der Gast ist über IDs in der URL der Seite festgelegt. Der Gast ist über den angemeldeten Benutzer festgelegt.
#### Sicherheit
Die Seite enthält persönliche Daten und ist nur nach Anmeldung erreichbar.
## Abläufe ## Abläufe
@ -357,29 +349,32 @@ Als bekannter Gast der ein defekten Geräte anmelden möchte,
## Konfigurationsparameter ## Konfigurationsparameter
- DJANGO_SECRET_KEY - DJANGO_SECRET_KEY: Secret Key für das Django Framework.
- DJANGO_DEBUG - DJANGO_DEBUG: Debug-Modus verwenden? Standard ist True.
- DJANGO_EMAIL_HOST
- DJANGO_EMAIL_PORT - DJANGO_EMAIL_HOST: eMail Server
- DJANGO_EMAIL_HOST_USER - DJANGO_EMAIL_PORT: eMail Server Port
- DJANGO_EMAIL_HOST_PASSWORD - DJANGO_EMAIL_HOST_USER: Benutzername für den eMail Server
- DJANGO_EMAIL_USE_TLS - DJANGO_EMAIL_HOST_PASSWORD: Passwort für den eMail Server
- OIDC_RP_CLIENT_SECRET - DJANGO_EMAIL_USE_TLS: TLS verwenden? Standard ist True.
- OIDC_RP_CLIENT_SECRET: Secret für den OIDC Prozess. Ist auch im Keycloak konfiguriert.
### Feste Konfiguration ### Feste Konfiguration
- ALLOWED_HOSTS - ALLOWED_HOSTS: Erlaubte Domainnamen. ("127.0.0.1", "localhost", "repapp.rc-hip.de", "anmeldung.repaircafe-hilpoltstein.de")
- LANGUAGE_CODE - LANGUAGE_CODE: de
- TIME_ZONE - TIME_ZONE: Europe/Berlin
- CSRF_TRUSTED_ORIGINS - CSRF_TRUSTED_ORIGINS: Siehe ALLOWED_HOSTS.
- AUTH_USER_MODEL - AUTH_USER_MODEL: CustomUser in RepApp Models definiert.
- AUTHENTICATION_BACKENDS - AUTHENTICATION_BACKENDS: Standard + Backends aus RepApp Backends.
- LOGIN_REDIRECT_URL
- OIDC_RP_CLIENT_ID - OIDC_RP_CLIENT_ID: OIDC Client ID, im Keycloak konfiguriert.
- OIDC_RP_SIGN_ALGO - OIDC_RP_SIGN_ALGO: RS256
- OIDC_OP_JWKS_ENDPOINT - OIDC_OP_JWKS_ENDPOINT: Keycloak URL
- OIDC_OP_AUTHORIZATION_ENDPOINT - OIDC_OP_AUTHORIZATION_ENDPOINT: Keycloak URL
- OIDC_OP_TOKEN_ENDPOINT - OIDC_OP_TOKEN_ENDPOINT: Keycloak URL
- OIDC_OP_USER_ENDPOINT - OIDC_OP_USER_ENDPOINT: Keycloak URL
- LOGIN_REDIRECT_URL
- LOGOUT_REDIRECT_URL - LOGIN_REDIRECT_URL: Debug: 127.0.0.1:8000, sonst https://anmeldung.repaircafe-hilpoltstein.de/
- LOGOUT_REDIRECT_URL: Siehe LOGIN_REDIRECT_URL

4
rc_hip/rc_hip/settings.py
View file

@ -183,5 +183,5 @@ if DEBUG:
LOGIN_REDIRECT_URL = "http://127.0.0.1:8000/" LOGIN_REDIRECT_URL = "http://127.0.0.1:8000/"
LOGOUT_REDIRECT_URL = "http://127.0.0.1:8000/" LOGOUT_REDIRECT_URL = "http://127.0.0.1:8000/"
else: else:
LOGIN_REDIRECT_URL = "https://repapp.rc-hip.de/" LOGIN_REDIRECT_URL = "https://anmeldung.repaircafe-hilpoltstein.de/"
LOGOUT_REDIRECT_URL = "https://repapp.rc-hip.de/" LOGOUT_REDIRECT_URL = "https://anmeldung.repaircafe-hilpoltstein.de/"