diff --git a/README.md b/README.md index 91f6037..4cc0e40 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Dieses Projekt, `ff-admin-server`, ist das Backend zur Verwaltung von Mitglieder Eine Demo zusammen mit der `ff-admin` finden Sie unter [https://admin-demo.ff-admin.de](https://admin-demo.ff-admin.de). +Das Handbuch zur Anwendung finden sie unter [https://ff-admin.de/ff-admin-handbook](https://ff-admin.de/ff-admin-handbook). + ## Installation Das Image exposed nur den Port 5000. Die Env-Variable SERVER_PORT kann nur im lokal ausführenden dev-Kontext verwendet werden. @@ -25,26 +27,13 @@ services: container_name: ff_member_administration_server restart: unless-stopped environment: - - DB_TYPE= # default ist auf mysql gesetzt + - DB_TYPE= # default ist auf mysql gesetzt - DB_HOST=ff-db - DB_PORT= # default ist auf 3306 gesetzt - DB_NAME=ffadmin - DB_USERNAME=administration_backend - DB_PASSWORD= - - JWT_SECRET= - - JWT_EXPIRATION= # default ist auf 15m gesetzt - - REFRESH_EXPIRATION= # default ist auf 1d gesetzt - - PWA_REFRESH_EXPIRATION= # default ist auf 5d gesetzt - - MAIL_USERNAME= - - MAIL_PASSWORD= - - MAIL_HOST= - - MAIL_PORT= # default ist auf 587 gesetzt - - MAIL_SECURE= # default ist auf false gesetzt - - CLUB_NAME= # default ist auf FF Admin gesetzt - - CLUB_WEBSITE= - - BACKUP_INTERVAL= # alle x Tage, sonst keine - - BACKUP_COPIES= # Anzahl parallel bestehender Backups - - BACKUP_AUTO_RESTORE= # default ist auf true gesetzt + - APPLICATION_SECRET= - USE_SECURITY_STRICT_LIMIT = (true|false) # default ist true - SECURITY_STRICT_LIMIT_WINDOW = [0-9]*(y|d|h|m|s) # default ist 15 - SECURITY_STRICT_LIMIT_REQUEST_COUNT = strict_request_count # default ist 15 @@ -91,8 +80,6 @@ networks: Die Verwendung von postgres wird aufgrund des Verhaltens bei Datenbank-Update-Fehlern empfohlen. -Die Verwendung von SQLite wird nur für die Entwicklung oder lokale Tests empfohlen. - Führen Sie dann den folgenden Befehl im Verzeichnis der compose-Datei aus, um den Container zu starten: ```sh