Umgebungsvariablen
Nachfolgend finden Sie die wichtigsten Umgebungsvariablen mit Standardwerten, falls vorhanden. Die Variablen für Docker- und paketbasierte Installationen können in einigen Fällen unterschiedlich sein. In der Spalte Beschränkung finden Sie Icons mit der folgenden Bedeutung:
- Nur für Docker-Installationen verfügbar:
- Nur für Paketinstallationen verfügbar:
- Verfügbar für beide Installationsvarianten: kein Icon
TIP
Wenn Sie eine .env
-Datei in Docker Compose-Installationen verwenden möchten, können Sie die mitgelieferte .env.dist
-Datei verwenden und sie als .env
kopieren. Auf diese Weise wird sie von Docker Compose automatisch übernommen und bei Aktualisierungen nicht überschrieben.
Verschiedenes
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
GPG_PATH | nicht gesetzt | Legt den Pfad der GPG-Installation fest. Nur benötigt wenn die PGP-Installation vom Standard abweicht oder Sie verschiedene PGP-Installationen verwenden wollen. | |
RAILS_LOG_TO_STDOUT | nicht gesetzt | Dies Einstellung kann während einem Update einer Paketinstallation überschrieben werden. Verwenden Sie enabled für eine Aktivierung bis zum nächsten Update. Verwenden Sie true für eine dauerhaft Aktivierung. | |
ZAMMAD_SAFE_MODE | nicht gesetzt | Seien Sie vorsichtig beim Ausführen von Befehlen im Safe-Mode in Produktivsystemen. Obwohl dieser Modus eine Rettung für manche Systeme sein kann, hat er auch das Potenzial, Systeme zu beschädigen. | |
ZAMMAD_BIND_IP | 127.0.0.1 | Die IP-Adresse, auf die Ihr Webserver lauscht. | |
S3_URL | nicht gesetzt | Erlaubt es, eine S3 Speicher-Konfiguration zu setzen. Beispiel für einen Wert: https://key:secret@s3.eu-central-1.amazonaws.com/zammad-storage-bucket?region=eu-central-1&force_path_style=true |
Zammad
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
VERSION | aktuelle stable Version von Zammad | Erlaubt die Anpassung des Zammad Image-Tags. Beispiel: 6.3.1-54 . Diese Default-Version kann bei einem Update von Zammad erhöht werden. Bitte sehen Sie sich die Beispiel env-Datei_ an für weitere Informationen. | |
AUTOWIZARD_JSON | nicht gesetzt | Diese Variable erlaubt es, eine initiale Konfiguration von Zammad zu definieren. Die Autowizard JSON ist nicht Inhalt dieser Dokumentation. Sie können allerdings einen Blick auf diese Beispiel-Datei werfen. | |
ZAMMAD_HTTP_TYPE | nicht gesetzt | Setzen Sie den http-Typ Ihrer Instanz. Mögliche Werte sind http und https . | |
ZAMMAD_FQDN | nicht gesetzt | Setzen Sie den FQDN Ihrer Instanz. | |
RAILS_TRUSTED_PROXIES | 127.0.0.1,::1 | Diese Einstellung ist wichtig für die korrekte Ermittlung der Client-IP-Adressen und darauf aufbauender Features wie Rate Limiting. Standardmäßig vertraut Zammad nur localhost Proxies. Jeder zusätzliche Proxy-Server muss hier unter Angabe der IP-Adresse (falls statisch) oder des Hostnamens angegeben werden. Hostnamen werden während des Start von Zammad aufgelöst, weshalb ein Neustart bei Änderungen der IP-Adresse des Proxy-Servers notwendig ist. Beachten Sie, dass Zammad im Docker-Kontext ggf. die IP-Adresse des Netzwerk-Gateways anstelle der Proxy-IP-Adresse sieht, sofern es sich um separate Netzwerke handelt. | |
ZAMMAD_PROCESS_DELAYED_ AI_JOBS_WORKERS | nicht gesetzt | Wieviele AI-Worker-Instanzen sollen gleichzeitig laufen. AI-Workers wickeln Zammads KI-Anfragen ab und rufen die Antworten vom konfigurierten KI-Anbieter ab. Standardmäßig läuft ein Worker. Nutzer mit selbst gehosteter KI sollten vorsichtig mit einer Erhöung sein, der KI-Dienst kann zusammenbrechen. Für Nutzer einer KI-Cloud mit einer großen Zammad-Instanz kann eine Erhöung hingegeben Sinn machen um eine Art Parallelisierung zu erreichen. Die maximale Anzahl an Workern beträgt 16 . | |
ZAMMAD_PROCESS_DELAYED_ AI_JOBS_WORKERS_ THREADS | 5 | Wieviele Threads sollen von einem KI-Worker bearbeitet werden (sofern Sie mehr als einen Worker haben, ist der Wert mit der Anzahl an Workern zu multiplizieren. Dies kann die KI-Verarbeitung beschleunigen. Seien Sie sich aber bewusst, dass ein Ruby-Worker ohnehin nur auf einem Core laufen kann. Die maximale Anzahl an Threads ist 16 . | |
MEMCACHE_SERVERS | - Docker: zammad-memcached:11211 - Paket: nicht gesetzt | Legen Sie Ihre eigene Memcached-Instanz fest, sofern Sie eine haben. Der Fallback bei Paket-Installationen ist /opt/zammad/tmp/cache* . | |
REDIS_URL | - Docker: redis://zammad-redis:6379 - Paket: nicht gesetzt | Legen Sie Ihre eigene Redis-Instanz fest, sofern Sie eine haben. Bitte beachten Sie, dass diese Methode aktuell keine Authentifizierung erlaubt. Der Fallback bei Paket-Installationen ist /opt/zammad/tmp/websocket_* . |
Elasticsearch
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
ELASTICSEARCH_ENABLED | true | Wenn Sie diese Variable auf false setzen, können Sie Ihr Zammad ohne Elasticsearch betreiben. Bitte beachten Sie, dass wir dringend davon abraten, dies zu tun. | |
ELASTICSEARCH_HOST | zammad-elasticsearch | Geben Sie einen Hostnamen oder eine Adresse für Ihre externes Elasticsearch-Cluster an. | |
ELASTICSEARCH_PORT | 9200 | Geben Sie bei Bedarf einen anderen Port für Elasticsearch an. | |
ELASTICSEARCH_SCHEMA | http | Standardmäßig ist Elasticsearch über HTTP erreichbar. | |
ELASTICSEARCH_NAMESPACE | zammad | Mit diesem Namensraum werden alle Zammad-bezogenen Indizes erstellt. Ändern Sie dies, wenn Sie externe Cluster verwenden. | |
ELASTICSEARCH_REINDEX | nicht gesetzt | Der Suchindex wird automatisch neu aufgebaut, wenn kein Index gefunden werden kann. Wenn Sie den Suchindex manuell neu aufbauen müssen, setzen Sie diese Variable entweder auf true oder führen Sie den Reindex-Befehl über Docker manuell aus. | |
ELASTICSEARCH_SSL_VERIFY | true | Erlaubt Ihnen, dass die Compose-Skripte bei Bedarf selbstsignierte SSL-Zertifikate für Ihre Elasticsearch-Installation ignorieren. | |
ELASTICSEARCH_HEAP_SIZE | 1G | Legt den verfügbaren Speicher für Elasticsearch fest. Wenn Sie Probleme mit ES und seiner Leistung haben, sollten Sie diesen Wert auf eine angemessene Größe erhöhen. |
PostgreSQL
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
POSTGRESQL_HOST | zammad-postgresql | Hostname Ihres PostgreSQL-Servers. Verwenden Sie Ihren eigenen, wenn Sie bereits einen haben. | |
POSTGRESQL_PORT | 5432 | Stellen Sie den Port Ihres PostgreSQL-Servers ein. | |
POSTGRESQL_USER | zammad | Der Datenbank Benutzer für Zammad. | |
POSTGRESQL_PASS | zammad | Das Passwort des Datenbank-Benutzers von Zammad. | |
POSTGRESQL_DB | zammad_production | Zammads zu verwendende Datenbank. | |
POSTGRESQL_OPTIONS | ?pool=50 | Zusätzliche PostgreSQL-Parameter, die an den Datenbank-URI angehängt werden. | |
POSTGRESQL_DB_CREATE | true | Standardmäßig erstellt Zammad die erforderliche Datenbank. Auf bereits existierenden Datenbankservern kann die Voreinstellung problematisch sein. |
Nginx
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
NGINX_EXPOSE_PORT | 8080 | Der Port, der für den Zugriff auf den Zammad-Stack von außen freigegeben werden soll. Ändern Sie diesen Wert, wenn Sie bereits einen bestehenden Dienst haben, der auf diesen Port hört. | |
NGINX_PORT | 8080 | Der interne Port, an dem der Nginx-Dienst lauschen wird. | |
NGINX_SERVER_NAME | _ | Standardmäßig wird der Nginx-Container von Zammad auf alle Anfragen antworten. Sie können Ihre IP / FQDN angeben, wenn Sie das möchten. | |
NGINX_SERVER_SCHEME | \$scheme | Wenn der Nginx-Container für Zammad nicht der Upstream-Server ist (d.h. Sie verwenden einen anderen Proxy vor Nginx), kann $scheme falsch sein. Sie können das korrekte Schema http oder https einstellen, falls nötig. | |
NGINX_CLIENT_MAX_BODY_SIZE | nicht gesetzt | Definieren Sie die maximale Größe der Daten, die ein Client an den Server senden kann. | |
ZAMMAD_RAILSSERVER_HOST | zammad-railsserver | Hostname des Rails-Server-Containers. | |
ZAMMAD_RAILSSERVER_PORT | 3000 | Port des Rails-Servers von Zammad. | |
ZAMMAD_RAILS_PORT | 3000 | Port des Rails-Servers von Zammad. | |
ZAMMAD_WEBSOCKET_HOST | zammad-websocket | Hostname des Websocket-Servers von Zammad. | |
ZAMMAD_WEBSOCKET_PORT | 6042 | Port des Websocket-Servers von Zammad. |
Leistungsoptimierung
Jede der unten aufgeführten Einstellungen bringt ihre eigenen Kompromisse mit sich. Es gibt hier keine empfohlenen Werte; die optimale Konfiguration hängt von den Ressourcen Ihres Systems und der typischen Anwendungslast ab.
Gehen Sie mit Vorsicht vor. Wenn Sie eine dieser Einstellungen anpassen, gibt es einen Punkt, an dem sich die Leistung eher verschlechtert als verbessert, oder andere Probleme auftreten.
Die nachstehenden Einstellungen können alle verfügbaren Datenbank-Verbindungen verwenden. Bitte beachten Sie die Datenbankserver-Konfiguration für weitere Informationen.
Variable | Beschränkung | Standardwert | Beschreibung |
---|---|---|---|
ZAMMAD_WEB_CONCURRENCY | nicht gesetzt | Erlaubt das Erstellen von n Workern, um mehr gleichzeitige Verbindungen für Zammads Web-UI zu ermöglichen. Falls Sie Hardware-Begrenzungen für Docker angewendet haben, sollte die CPU-Einstellung des Zammad-Railsservers mit dem Wert dieser Variable übereinstimmen. | |
ZAMMAD_PROCESS_SESSION_ JOBS_WORKERS | nicht gesetzt | Wie viele Instanzen des Session Workers gleichzeitig laufen sollen. Das Erhöhen dieses Wertes kann Hintergrundaufgaben (wie die Automatisierung) beschleunigen, wenn viele Benutzer gleichzeitig auf Zammad sind. Es ist jedoch nicht sinnvoll, diese Einstellung zu ändern, wenn Sie weniger als 40 gleichzeitig aktive Benutzer haben. Das Erhöhen der Anzahl der Worker kann eine Menge Ressourcen verbrauchen! Falls Sie Hardware-Begrenzungen für Docker angewendet haben, sollte die CPU-Einstellung des Zammad-Schedulers der Summe aller Variablen der Worker-Einstellungen entsprechen. | |
ZAMMAD_PROCESS_SCHEDULED_ JOBS_WORKERS | nicht gesetzt | Erlaubt das Erstellen von 1 unabhängigem Worker für geplante Aufgaben, um Zammads Hintergrundworker zu entlasten. Maximale Anzahl von Workern: 1 . Falls Sie Hardware-Begrenzungen für Docker angewendet haben, sollte die Zammad-Scheduler CPU-Einstellung der Summe aller Worker-Einstellungen entsprechen. | |
ZAMMAD_PROCESS_DELAYED_ JOBS_WORKERS | nicht gesetzt | Erlaubt das Erstellen von n Delayed-Jobs Workern, um den Druck von Zammads Hintergrundworker zu nehmen. Falls Sie Hardware-Begrenzungen für Docker angewendet haben, sollte die Zammad-Scheduler CPU-Einstellung der Summe aller Worker-Einstellungen entsprechen. |
Umgebungsvariablen setzen
Es hängt davon ab, wie Sie Zammad installiert haben (Paket, Docker). Entweder setzen Sie sie über den Befehl zammad config
, wie Sie unten sehen können, verwenden die Art und Weise Ihres Systems, Variablen über die Kommandozeile zu setzen (z.B. export VARIABLE=wert)
, legen eine .env
Datei in das Verzeichnis oder Sie verwenden sogar eine GUI wie Portainer, um Variablen für eine Docker-Installation zu setzen.
Beispiele für Paketinstallationen:
Setzen Sie OPTION auf "wert":
zammad config:set OPTION=wert
OPTION abfragen:
zammad config:get OPTION
OPTION entfernen:
zammad config:unset OPTION
Starten Sie Zammad nach der Änderung der Einstellungen neu:
sudo systemctl restart zammad