Umgebungsvariablen
Verfügbare Variablen
Allgemeine Variablen
| Variablenname | Typ | Standard-Wert | Beschreibung |
|---|---|---|---|
| MOSPARO_CONFIG_FILE_PATH | String | leer | Wenn Sie eine bestimmte Datei als Konfigurationsdatei verwenden möchten, konfigurieren Sie die folgende Umgebungsvariable und setzen Sie sie auf den Pfad Ihrer Konfigurationsdatei. Der Pfad muss absolut sein. |
| DATABASE_MYSQL_SSL | Boolean | 0 | Legt fest, ob die MySQL-Verbindung verschlüsselt werden soll. 1, um die verschlüsselte Verbindung zu aktivieren. |
| DATABASE_MYSQL_SSL_KEY | String | leer | Legt den Dateipfad für den SSL-Schlüssel fest. |
| DATABASE_MYSQL_SSL_CERT | String | leer | Legt den Dateipfad für das SSL-Zertifikat fest. |
| DATABASE_MYSQL_SSL_CA | String | leer | Legt den Dateipfad zur Zertifizierungsstelle fest. |
| DATABASE_MYSQL_SSL_VERIFY_SERVER_CERT | Boolean | 0 | Legt fest, ob das Serverzertifikat überprüft werden soll. 1, um das Zertifikat zu überprüfen. |
| MOSPARO_UPDATES_ENABLED | Boolean | 1 | Aktiviert oder deaktiviert die Möglichkeit, mosparo innerhalb der Benutzeroberfläche zu aktualisieren. |
| MOSPARO_AUTOMATIC_UPDATE_CHECK_ENABLED | Boolean | 1 | Aktiviert oder deaktiviert die automatische Prüfung auf eine neue Version beim Zugriff auf die Benutzeroberfläche. |
| MOSPARO_ENV_SUFFIX | String | leer | Mit dem Suffix ist es möglich, den Namen der mosparo Konfigurationsdatei anzupassen. |
| MOSPARO_CACHE_ADAPTER | String | filesystem | Damit wird der Adapter für den gemeinsamen Cache eingestellt. Der gemeinsame Cache hilft bei der gemeinsamen Nutzung von Cache-Daten durch mehrere Nodes. Verfügbare Optionen: filesystem, memcached, redis |
| MOSPARO_PREPARE_CSS_FILES_IN_SHARED_CACHE | Boolean | 0 | Wenn diese Option aktiviert ist, speichert mosparo die vorbereiteten CSS-Dateien im gemeinsamen Cache statt in einer physischen Datei auf Ihrem Server. Dies ist nützlich, wenn Sie mehrere Nodes für mosparo verwenden, da Sie die Dateien nicht zwischen Ihren Nodes synchronisieren müssen. |
| MOSPARO_USE_SHARED_CACHE_FOR_RULE_ITEMS | Boolean | 0 | Um den Validierungsprozess zu optimieren, kann es hilfreich sein, die Regel-Einträge für einen Wert im gemeinsamen Cache zwischenzuspeichern. Je nach Anzahl der Regeln kann das Zwischenspeichern von Regel-Einträgen den Validierungsprozess erheblich beschleunigen. Die Regel-Einträge werden abhängig vom Wert des Feldes gespeichert. Wenn derselbe Wert erneut validiert wird, werden die Regel-Einträge aus dem gemeinsamen Cache geladen. |
| MOSPARO_RULE_ITEMS_CACHE_TTL | Integer | 3600 | Wir speichern die Schlüssel der Cache-Elemente nicht. Aus diesem Grund können wir den Cache nicht bereinigen, wenn ein Regel-Eintrag geändert wird. Es ist wichtig, die TTL auf einen geeigneten Wert einzustellen. Ist die TTL zu gross, müssen Sie nach der Änderung eines Regel-Eintrags zu lange warten oder den Cache manuell leeren. Ist die TTL zu kurz, kann der Cache Ihnen keinen Nutzen bringen. Bei der Optimierung der Regeln empfehlen wir eine maximale TTL von 3600 Sekunden. Wenn Sie die Regel-Einträge nicht häufig ändern, können Sie die TTL auf einen Tag (86400 Sekunden) oder einen anderen Wert Ihrer Wahl einstellen. |
| MOSPARO_CLEANUP_GRACE_PERIOD_ENABLED | Boolean | 0 | Wenn diese Option aktiviert ist, wird der Frontend-API-Controller von mosparo die Datenbank erst nach 24 Stunden bereinigen. Dies ist hilfreich, wenn Sie einen Cronjob verwenden, um die Datenbank jede Nacht zu bereinigen. In diesem Fall möchten Sie diese Aufgabe nicht dem Frontend-API-Controller überlassen. Dazu können Sie die Karenzzeit aktivieren, d. h. die Frontend-API-Steuerung wartet weitere 24 Stunden, bevor sie mit der Bereinigung beginnt. In diesen 24 Stunden kann der Cronjob die Datenbank erneut bereinigen, so dass der Frontend-API-Controller die Datenbank technisch gesehen nie bereinigt, ausser wenn der Cronjob nicht erfolgreich ausgeführt wurde. |
| MOSPARO_SUBMIT_TOKEN_RETENTION_PERIOD | Integer | 24 | Legt die Anzahl der Stunden fest, nach denen ein ungenutzter Einsende-Code oder eine nicht überprüfte Einsendung aus der Datenbank gelöscht wird. Der Wert beträgt mindestens 1 Stunde und höchstens 24 Stunden. |
| MOSPARO_SUBMISSION_RETENTION_PERIOD | Integer | 14 | Legt die Anzahl der Tage fest, nach denen eine verifizierte oder als Spam identifizierte Einsendung aus der Datenbank gelöscht wird. Der Wert beträgt mindestens 1 Tag und maximal 14 Tage. |
| MOSPARO_CLEANUP_PROCESS_INTERVAL | Integer | 6 | Legt das Bereinigungsintervall fest, in dem die regelmässige Bereinigung durchgeführt wird. Das Intervall beträgt mindestens 1 Stunde und maximal 24 Stunden. |
| MOSPARO_CLEANUP_UNFINISHED_INTERVAL | Integer | 10 | Legt das Intervall fest, in dem eine Bereinigung geplant wird, wenn die vorherige Bereinigung nicht abgeschlossen wurde. Das Intervall beträgt mindestens 1 Minute und maximal 360 Minuten. |
| MOSPARO_BYPASS_HEALTH_CHECK | Boolean | 0 | Wenn eine positive Antwort von der Health-Prüfung erforderlich ist, können Sie diese Umgebungsvariable aktivieren, um die Health-Prüfung zu umgehen. Dies kann nützlich sein, wenn der Docker-Container als "unhealthy" erkannt wird und der Container ohne Health-Prüfung gestartet werden muss. |
| MOSPARO_HEALTH_ALLOW_LIST | String | 127.0.0.1,::1 | Nur die in dieser Umgebungsvariablen aufgeführten IP-Adressen können auf die Health-API zugreifen. Standardmässig kann nur der localhost auf die Health-API zugreifen. Sie können IP-Adressen (zum Beispiel, 10.11.12.13) oder Subnetze mit der Subnetzmaske in CIDR-Notation (zum Beispiel, 10.11.12.0/24) hinzufügen, getrennt durch ein Komma (,). |
| FILESYSTEM_CACHE_PATH | String | leer | Diese Umgebungsvariable definiert den Pfad zum Dateisystem-Cache für den geteilten Cache. Wenn die Variable leer ist, wird der geteilte Cache im temporären Verzeichnis des Systems gespeichert. Wenn Sie den geteilten Cache in einem bestimmten Verzeichnis speichern möchten, geben Sie den absoluten Pfad zu diesem Verzeichnis mit dieser Umgebungsvariablen an. |
| MEMCACHED_URL | String | memcached://localhost | Verbindungsdetails für die Verbindung zu Ihrem Memcached-Cache. Hat keinen Effekt, solange MOSPARO_CACHE_ADAPTER nicht auf memcached gesetzt ist. Konfigurationsbeispiele finden Sie in der Symfony-Dokumentation. |
| REDIS_URL | String | redis://localhost | Verbindungsdetails für die Verbindung zu Ihrem Redis-Cache. Hat keine Auswirkungen, solange MOSPARO_CACHE_ADAPTER nicht auf redis gesetzt ist. Konfigurationsbeispiele finden Sie in der Symfony-Dokumentation. |
| TRUSTED_PROXIES | String | 127.0.0.1 | Wenn Sie mosparo hinter einem Load Balancer oder einer anderen Art von Reverse Proxy einsetzen, kennt mosparo die tatsächliche IP-Adresse des Benutzers nicht. Dafür sendet Ihr Reverse Proxy spezielle Header an mosparo (z.B. X-Forwarded-For). Aber mosparo (und Symfony im Allgemeinen) akzeptiert diese Header nur von vertrauenswürdigen Proxys. Dazu müssen Sie die IP-Adressen Ihrer Reverse-Proxies in dieser Variable auflisten, damit mosparo weiss, welchen es vertrauen kann. Sie können IP-Adressen (zum Beispiel, 10.11.12.13) oder Subnetze mit der Subnetzmaske in CIDR-Notation (zum Beispiel, 10.11.12.0/24) hinzufügen. Sie können REMOTE_ADDR hinzufügen, um alle Clients zu akzeptieren, aber Sie sollten sicherstellen, dass nur Ihre Reverse-Proxies auf Ihren Webserver zugreifen können. |
Docker-spezifische Variablen
| Variablenname | Typ | Standard-Wert | Image | Beschreibung |
|---|---|---|---|---|
| MOSPARO_ENABLE_WEBSERVER | Boolean | 1 | Standard | Aktiviert oder deaktiviert den Webserver im mosparo-Image. |
| MOSPARO_ENABLE_CRON | Boolean | 1 | Standard | Aktiviert oder deaktiviert die Cron-Jobs im mosparo-Image. |
| MOSPARO_RUN_NGINX | Boolean | 1 | Unpriviligiert | Aktiviert oder deaktiviert den nginx-Webserver im mosparo-Image. |
| MOSPARO_RUN_PHP_FPM | Boolean | 1 | Unpriviligiert | Aktiviert oder deaktiviert die PHP FPM im mosparo-Image. |
Konfiguration
Datei .env.local
Für eine normale Installation (nicht für eine Docker-basierte) wird empfohlen, eine neue Datei mit dem Namen .env.local zu erstellen und die erforderlichen Umgebungsvariablen mit den gewünschten Werten hinzuzufügen.
Kopieren Sie die Datei .env.local.dist und passen Sie die Werte für einen leichteren Start an. Die Datei enthält alle möglichen Variablen und beschreibt, wie sie zu verwenden sind.
Docker
Docker Compose
Wenn Sie Docker Compose zur Konfiguration der Container verwenden, setzen Sie die Umgebungsvariablen in der Docker Compose-Datei.
...
mosparo_web:
image: mosparo/mosparo:latest
ports:
- 8080:80
restart: always
environment:
- MOSPARO_ENABLE_WEBSERVER=1
- MOSPARO_CLEANUP_GRACE_PERIOD_ENABLED=1
- MOSPARO_CACHE_ADAPTER=memcached
- MEMCACHED_URL=memcached://memcached
...
Docker direkt
Wenn Sie einen Docker-Container über die Befehlszeile starten, können Sie die Umgebungsvariablen als Argument angeben:
docker run -d -e MOSPARO_CACHE_ADAPTER='memcached' -p 8080:80 --name mosparo_container mosparo/mosparo:latest
Weitere Informationen hierzu finden Sie in der [Docker-Dokumentation] (https://docs.docker.com/engine/containers/run/#environment-variables).
Andere Option
Wahrscheinlich können Sie die Umgebungsvariablen auch in der Konfiguration Ihres Webservers angeben (abhängig von Ihrem Webserver). Schauen Sie dazu in der Dokumentation Ihres Webservers nach.