Toolkit-Einstellungen - Ayakaleaf Pro

Diese Seite beschreibt die Umgebungsvariablen, die in der Datei config/overleaf.rc für Toolkit-Deployments unterstützt werden. Die Datei config/overleaf.rc besteht aus Variablendefinitionen in der Form NAME=value. Zeilen, die mit # beginnen, werden als Kommentare behandelt.

Nach jeder Änderung an overleaf.rc oder variables.env müssen Sie die Docker-Container neu erstellen, indem Sie bin/up ausführen.

Container

`sharelatex`

Name	Beschreibung
`PROJECT_NAME`	Legt den Wert des Flags `--project-name` fest, das an `docker-compose` übergeben wird. Dies ist nützlich, wenn mehrere Overleaf-Instanzen auf einem Host laufen, da jede Instanz einen anderen Projektnamen haben kann. - Standard: `overleaf`
`OVERLEAF_IMAGE_NAME`	Docker-Image, das vom Server-Pro/CE-Anwendungscontainer verwendet wird. Dies ist nur der Name des Docker-Images; der Tag des Docker-Images wird aus `config/version` bezogen. - Standard: - Server Pro: `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition: `sharelatex/sharelatex`
`SERVER_PRO`	Wenn auf `true` gesetzt, verwendet das Toolkit das Server-Pro-Image (`ghcr.io/ayaka-notes/overleaf-pro`) anstelle des standardmäßigen Server-CE-Images (`sharelatex/sharelatex`). - Standard: `false`
`GIT_BRIDGE_ENABLED`	Auf `true` setzen, um die git-bridge-Funktion zu aktivieren (nur Server Pro). Weitere Informationen finden Sie in der Benutzerdokumentation unter https://www.overleaf.com/learn/how-to/Git_integration. - Standard: `false`
`GIT_BRIDGE_IMAGE`	Docker-Image, das vom git-bridge-Container verwendet wird (nur Server Pro). Dies ist nur der Name des Docker-Images; der Tag des Docker-Images wird aus `config/version` bezogen. - Standard: `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
`GIT_BRIDGE_DATA_PATH`	Legt den Pfad zum Verzeichnis fest, das in den Container `git-bridge` (nur Server Pro) eingebunden und zum Speichern der Git-Repositorys verwendet wird. Dies kann entweder ein vollständiger Pfad (beginnend mit `/`) oder ein Pfad relativ zum Basisverzeichnis des Toolkits sein.
`GIT_BRIDGE_LOG_LEVEL`	Konfiguriert die Protokollierungsstufe des Containers `git-bridge`. Verfügbare Stufen: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`. - Standard: `INFO`
`SIBLING_CONTAINERS_ENABLED`	Wenn auf `true` gesetzt, verwendet das Toolkit die Technik der Sibling Containers, um Projekte in separaten Sandboxes zu kompilieren, wobei für jedes Projekt ein eigener Docker-Container verwendet wird. Weitere Informationen finden Sie in der Dokumentation <server-pro-only-configuration/sandboxed-compiles>. - Erfordert: `SERVER_PRO=true` - Standard: `true`
`SIBLING_CONTAINERS_PULL`	Wenn auf `true` gesetzt, lädt das Toolkit beim Ausführen des Befehls `bin/up` automatisch alle TeX-Live-Images herunter, die über `ALL_TEX_LIVE_DOCKER_IMAGES` in der Datei config/variables.env festgelegt sind. - Standard: `true`
`DOCKER_SOCKET_PATH`	Legt den Pfad zum Docker-Socket auf dem Host-Rechner fest (dem Rechner, auf dem das Toolkit läuft). Wenn `SIBLING_CONTAINERS_ENABLED` auf `true` gesetzt ist, wird der Socket in den Container eingebunden, damit der Compiler-Dienst neue Docker-Container auf dem Host starten kann. - Erfordert: `SIBLING_CONTAINERS_ENABLED=true` - Standard: `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	Legt den Pfad zum Verzeichnis fest, das in den Hauptcontainer `sharelatex` eingebunden und zum Speichern von Kompilierungsdaten verwendet wird. Dies kann entweder ein vollständiger Pfad (beginnend mit `/`) oder ein Pfad relativ zum Basisverzeichnis des Toolkits sein. - Standard: `data/overleaf`
`OVERLEAF_LISTEN_IP`	Legt die Host-IP-Adresse(n) fest, an die sich der Container bindet. Wenn dieser Wert beispielsweise auf `0.0.0.0` gesetzt ist, ist die Weboberfläche über jede IP-Adresse des Hosts erreichbar. Für direkten Containerzugriff muss `OVERLEAF_LISTEN_IP` auf Ihre öffentliche IP-Adresse gesetzt werden. Wird `OVERLEAF_LISTEN_IP` auf `0.0.0.0` oder die externe IP Ihres Hosts gesetzt, führt dies in Verbindung mit dem typischerweise zu Fehlern. - Standard: `127.0.0.1`
`OVERLEAF_PORT`	Legt den Host-Port fest, an den sich der Container bindet. Wenn dieser Wert beispielsweise auf `8099` und `OVERLEAF_LISTEN_IP` auf `127.0.0.1` gesetzt ist, ist die Weboberfläche unter `http://localhost:8099` erreichbar. - Standard: `80`
`OVERLEAF_LOG_PATH`	Legt den Pfad zum Verzeichnis fest, das in den Hauptcontainer `sharelatex` eingebunden und verwendet wird, um Anwendungsprotokolle auf dem Docker-Host verfügbar zu machen. Dies kann entweder ein vollständiger Pfad (beginnend mit `/`) oder ein Pfad relativ zum Basisverzeichnis des Toolkits sein. Entfernen Sie den Konfigurationseintrag, um den Bind-Mount zu deaktivieren. Wenn nicht gesetzt, werden die Protokolle beim Neuerstellen des Containers verworfen. Siehe für Informationen zur Protokollierung. - Standard: nicht gesetzt

`mongo`

Name	Beschreibung
`MONGO_ENABLED`	Wenn auf `true` gesetzt, erstellt das Toolkit einen MongoDB-Container für die Datenbank. Wenn auf `false` gesetzt, wird dieser Container nicht erstellt, und das System verwendet stattdessen die durch `MONGO_URL` angegebene MongoDB-Datenbank. - Standard: `true`
`MONGO_URL`	Gibt die MongoDB-Verbindungs-URL an, die verwendet wird, wenn `MONGO_ENABLED` auf `false` gesetzt ist. - Standard: nicht gesetzt
`MONGO_DATA_PATH`	Legt den Pfad zum Verzeichnis fest, das in den Container `mongo` eingebunden und zum Speichern der MongoDB-Datenbank verwendet wird. Dies kann entweder ein vollständiger Pfad (beginnend mit `/`) oder ein Pfad relativ zum Basisverzeichnis des Toolkits sein. Diese Option betrifft nur den lokalen Container `mongo`, der erstellt wird, wenn `MONGO_ENABLED` auf `true` gesetzt ist. - Standard: `data/mongo`
`MONGO_IMAGE`	Docker-Image, das vom MongoDB-Container verwendet wird. Dies ist nur der Name des Docker-Images; der Tag des Docker-Images gehört in `MONGO_VERSION` (siehe unten). - Standard: `mongo`
`MONGO_VERSION`	Vom MongoDB-Container verwendete MongoDB-Version. Der Wert muss mit der MongoDB-Hauptversion und einem Punkt beginnen, z. B. `6.0` oder `6.0-with-suffix`. - Standard: `6.0`

`redis`

Name	Beschreibung
`REDIS_ENABLED`	Wenn auf `true` gesetzt, erstellt das Toolkit einen Redis-Container für die Redis-Datenbank. Wenn auf `false` gesetzt, wird dieser Container nicht erstellt, und das System verwendet stattdessen die durch `REDIS_HOST` und `REDIS_PORT` angegebene Redis-Datenbank. - Standard: `true`
`REDIS_HOST`	Gibt den Redis-Host an, der verwendet wird, wenn `REDIS_ENABLED` auf `false` gesetzt ist. - Standard: nicht gesetzt
`REDIS_PORT`	Gibt den Redis-Port an, der verwendet wird, wenn `REDIS_ENABLED` auf `false` gesetzt ist. - Standard: nicht gesetzt
`REDIS_DATA_PATH`	Legt den Pfad zum Verzeichnis fest, das in den Container `redis` eingebunden und zum Speichern der Redis-Datenbank verwendet wird. Dies kann entweder ein vollständiger Pfad (beginnend mit `/`) oder ein Pfad relativ zum Basisverzeichnis des Toolkits sein. Diese Option betrifft nur den lokalen Container `redis`, der erstellt wird, wenn `REDIS_ENABLED` auf `true` gesetzt ist. - Standard: `data/redis`
`REDIS_AOF_PERSISTENCE`	Aktiviert die AOF-Persistenz (Append Only File) für Redis. Dies ist die empfohlene Konfiguration für die Redis-Persistenz. Weitere Details finden Sie im Abschnitt <../../../maintenance/data-and-backups#aof-append-only-file> in <../../maintenance/data-and-backups>. - Standard: `true`

`nginx`

Name	Beschreibung
`NGINX_ENABLED`	Wenn auf `true` gesetzt, erstellt das Toolkit einen NGINX-Container, der als TLS-Proxy fungiert. - Standard: `false`
`NGINX_CONFIG_PATH`	Pfad zur NGINX-Konfigurationsdatei für den TLS-Proxy. - Standard: `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	Legt die Host-IP-Adresse(n) fest, an die sich der TLS-Proxy-Container für HTTPS bindet. Wenn dieser Wert beispielsweise auf `0.0.0.0` gesetzt ist, ist die HTTPS-Weboberfläche über jede IP-Adresse des Hosts erreichbar. In der Regel sollte dieser Wert auf die externe IP Ihres Hosts gesetzt werden. - Standard: `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	Legt die Host-IP-Adresse(n) fest, an die sich der TLS-Proxy-Container für die HTTP-Weiterleitung bindet. Wenn dieser Wert beispielsweise auf `127.0.1.1` gesetzt ist, werden HTTP-Verbindungen zu `127.0.1.1` auf die HTTPS-Weboberfläche umgeleitet. In der Regel sollte dieser Wert auf die externe IP Ihres Hosts gesetzt werden. Setzen Sie ihn nicht auf `0.0.0.0`, da dies typischerweise zu einem Konflikt mit `OVERLEAF_LISTEN_IP` führt. - Standard: `127.0.1.1`
`NGINX_HTTP_PORT`	Legt den Host-Port fest, an den sich der TLS-Proxy-Container für HTTP bindet. - Standard: `80`
`TLS_PORT`	Legt den Host-Port fest, an den sich der TLS-Proxy-Container für HTTPS bindet. - Standard: `443`
`TLS_PRIVATE_KEY_PATH`	Pfad zum privaten Schlüssel für den TLS-Proxy. - Standard: `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	Pfad zum öffentlichen Zertifikat für den TLS-Proxy. - Standard: `config/nginx/certs/overleaf_certificate.pem`

Zuletzt geändert am 5. Oktober 2026