5. Ihre Instanz personalisieren

​

Ihre Instanz personalisieren

Bevor Sie Ihre Overleaf-Instanz zum ersten Mal starten, ergänzen Sie zwei Konfigurationsdateien mit Ihren individuellen Angaben:

Datei	Gelesen von	Hier festgelegt
config/overleaf.rc	den Toolkit-Skripten, etwa bin/up	wie die Container laufen: OVERLEAF_LISTEN_IP, OVERLEAF_PORT, SERVER_PRO, Datenpfade
config/variables.env	der Anwendung im Container	wie sich Overleaf verhält: OVERLEAF_SITE_URL, E-Mail, TeX Live-Images

1. Die Variablendatei bearbeiten

   Öffnen Sie config/variables.env in Ihrem bevorzugten Texteditor und setzen Sie die unten aufgeführten Umgebungsvariablen auf die erforderlichen Werte.

2. Listen-Adresse und Port

   Standardmäßig veröffentlicht das Toolkit die Weboberfläche unter 127.0.0.1:80, sodass sie nur in einem Browser auf dem Server selbst geöffnet werden kann. Andere Computer erhalten die Fehlermeldung „connection refused“ oder „server not found“. Um dies zu ändern, bearbeiten Sie config/overleaf.rc:

   config/overleaf.rc

   OVERLEAF_LISTEN_IP=0.0.0.0
   OVERLEAF_PORT=8080
   

   OVERLEAF_LISTEN_IP ist die Host-IP-Adresse, an die sich der Container bindet, und OVERLEAF_PORT ist der Host-Port. Zusammen bilden sie die Docker-Portzuordnung OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Wählen Sie die Werte, die zu Ihrem Setup passen:

   Setup	OVERLEAF_LISTEN_IP	OVERLEAF_PORT	Im Browser öffnen
   Nur auf diesem Rechner (Standard)	127.0.0.1	80	http://localhost
   Andere Computer im LAN oder aus dem Internet verbinden sich direkt	0.0.0.0 oder eine IP des Servers	80 oder ein beliebiger freier Port	http://<server-ip>:<port>
   Hinter Ihrem eigenen Reverse Proxy (NGINX, Caddy, Cloudflare Tunnel) auf demselben Host	127.0.0.1	ein beliebiger freier Port	die URL des Proxys
   Hinter dem TLS-Proxy des Toolkit	127.0.0.1	80	https://<your-domain>

   Wenn Port 80 auf dem Host bereits belegt ist, zum Beispiel durch einen anderen Webserver, setzen Sie OVERLEAF_PORT auf einen freien Port wie 8080. Andernfalls schlägt bin/up mit bind: address already in use fehl.

   Von Docker veröffentlichte Ports umgehen Host-Firewalls wie ufw und firewalld. Mit 0.0.0.0 ist die Instanz aus jedem Netzwerk erreichbar, mit dem der Server verbunden ist. Auf einem Cloud-Server müssen Sie den Port außerdem in der Sicherheitsgruppe des Anbieters freigeben. Verwenden Sie HTTPS, bevor Sie die Instanz dem Internet zugänglich machen, siehe TLS-Proxy.

   Sie können mit dem Standardwert beginnen und die Instanz zunächst über localhost öffnen. Um später den Zugriff von anderen Computern zu erlauben, ändern Sie diese beiden Variablen in config/overleaf.rc sowie OVERLEAF_SITE_URL in config/variables.env und führen Sie dann erneut bin/up aus, um die Container neu zu erstellen.

3. Erforderliche Umgebungsvariablen

   Aktualisieren Sie die folgenden Variablen in config/variables.env:

   Name	Beschreibung	Beispiel
   OVERLEAF_SITE_URL	Die Adresse, unter der Ihre Overleaf-Instanz öffentlich erreichbar ist. Sie wird in öffentlichen Links und bei Verbindungen über Websockets verwendet und muss daher korrekt konfiguriert sein!	https://overleaf.lilliput.com
   OVERLEAF_EMAIL_FROM_ADDRESS	Diese E-Mail-Adresse wird als from-Adresse für alle ausgehenden E-Mails verwendet.	[e-mail]
   OVERLEAF_ADMIN_EMAIL	Die E-Mail-Adresse, unter der Benutzer die für den Betrieb der Website verantwortliche Person erreichen können.	[e-mail]

   OVERLEAF_SITE_URL ist die Adresse, die Benutzer in ihren Browser eingeben, nicht die Listen-Adresse. Geben Sie den Port an, wenn er nicht 80 (HTTP) oder 443 (HTTPS) ist, zum Beispiel http://192.168.1.20:8080. Verwenden Sie nicht http://0.0.0.0. Wenn OVERLEAF_SITE_URL nicht mit der Adresse im Browser übereinstimmt, kann der Editor keine Verbindung herstellen, und Links in E-Mails sowie OAuth-Callbacks verweisen an die falsche Stelle.

   Ohne Mailserver lassen Sie OVERLEAF_EMAIL_FROM_ADDRESS ungesetzt: Overleaf sendet dann keine E-Mails, und Sie können neuen Benutzern ihren Aktivierungslink selbst geben, siehe die Fragen & Antworten unter Öffentlicher Zugriff.

   Setzen Sie außerdem OVERLEAF_SESSION_SECRET auf einen mit openssl rand -hex 32 erzeugten Wert. Ohne diesen meldet jedes bin/up, das den Container neu erstellt, sowie jedes Upgrade alle Benutzer ab. Siehe die Fragen & Antworten unter Umgebungsvariablen.

   Wenn Sie diese Umgebungsvariablen aktualisiert haben, speichern Sie die Datei und schließen Sie den Editor.

4. Sandbox-Kompilierung einrichten

   Konfigurieren Sie als Nächstes TeX Live Full für sandboxed-compiles.md. Öffnen Sie config/variables.env und aktualisieren Sie die folgenden Umgebungsvariablen:

   config/variables.env

   ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
   ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
   TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
   
5. Ihre Instanz starten

   Um Ihre Instanz zu starten, führen Sie Folgendes aus:

   Start the instance

   bin/up
   

   Dieser Befehl lädt die benötigten Images einschließlich texlive herunter, erstellt die Container (mit Ihren Anpassungen) und startet die Instanz. Sie sollten Log-Ausgaben der verschiedenen Docker-Container sehen.

   Um sie später erneut zu starten (ohne an die Log-Ausgabe angehängt zu werden), führen Sie Folgendes aus:

   Start without attaching to logs

   bin/start
   

Das Toolkit verwendet docker compose, um die Overleaf-Docker-Container zu verwalten. Es stellt eine Reihe von Skripten bereit, die docker compose kapseln und sich um die meisten Details für Sie kümmern.

Wenn alles funktioniert, sollten Sie die Anmeldeseite Ihrer neuen Overleaf-Instanz sehen, indem Sie in Ihrem Browser http://127.0.0.1/ oder http://localhost/ aufrufen. Wenn Sie OVERLEAF_LISTEN_IP oder OVERLEAF_PORT geändert haben, öffnen Sie stattdessen die Adresse aus der Tabelle im Schritt Listen-Adresse und Port, zum Beispiel http://<server-ip>:8080.

Um zu prüfen, unter welcher Adresse und welchem Port die Weboberfläche veröffentlicht ist, führen Sie Folgendes aus:

Show the published port

bin/docker-compose port sharelatex 80

Die Ausgabe, zum Beispiel 0.0.0.0:8080, zeigt die verwendete Host-IP-Adresse und den Port. Wird 127.0.0.1 angezeigt, ist die Instanz nur vom Server selbst aus erreichbar.

Je nach Ihrer Netzwerkkonfiguration und dem Hosting-Ort Ihrer Overleaf-Instanz sind möglicherweise zusätzliche Konfigurationsänderungen erforderlich. Weitere Details finden Sie in den Toolkit-Einstellungen: toolkit-settings.md