.env.example

@@ -1,4 +1,4 @@
-DB_TYPE = (mysql|sqlite|postgres)
+DB_TYPE = (mysql|sqlite|postgres) # default ist mysql
 
 ## BSP für mysql
 DB_PORT = 3306
@@ -19,20 +19,20 @@ DB_HOST = filename.db
 
 SERVER_PORT = portnumber
 
-JWT_SECRET = ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890
-JWT_EXPIRATION = [0-9]*(y|d|h|m|s)
-REFRESH_EXPIRATION = [0-9]*(y|d|h|m|s)
-PWA_REFRESH_EXPIRATION = [0-9]*(y|d|h|m|s)
+JWT_SECRET = ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890 # besitzt default
+JWT_EXPIRATION = [0-9]*(y|d|h|m|s) # default ist 15m
+REFRESH_EXPIRATION = [0-9]*(y|d|h|m|s) # default ist 1d
+PWA_REFRESH_EXPIRATION = [0-9]*(y|d|h|m|s) # default ist 5d
 
 MAIL_USERNAME = mail_username
 MAIL_PASSWORD = mail_password
 MAIL_HOST = mail_hoststring
-MAIL_PORT = mail_portnumber
-MAIL_SECURE = (true|false) // true for port 465, fals for other ports
+MAIL_PORT = mail_portnumber # default ist 587
+MAIL_SECURE = (true|false) # true für port 465, false für anders gewählten port
 
 CLUB_NAME = clubname #default FF Admin
-CLUB_WEBSITE = https://my-club-website-url
+CLUB_WEBSITE = https://my-club-website-url #optional, muss aber mit http:// oder https:// beginnen
 
-BACKUP_INTERVAL = number of days (min 1)
-BACKUP_COPIES = number of parallel copies
+BACKUP_INTERVAL = number of days (min 1) # default 1
+BACKUP_COPIES = number of parallel copies #default 7
 BACKUP_AUTO_RESTORE = (true|false) # default false

README.md

@@ -38,7 +38,7 @@ services:
       - MAIL_USERNAME=<mailadress|username>
       - MAIL_PASSWORD=<password>
       - MAIL_HOST=<url>
-      - MAIL_PORT=<port> # default ist auf 578 gesetzt
+      - MAIL_PORT=<port> # default ist auf 587 gesetzt
       - MAIL_SECURE=<boolean> # default ist auf false gesetzt
       - CLUB_NAME=<tobemodified> # default ist auf FF Admin gesetzt
       - CLUB_WEBSITE=<tobemodified>