Migration von docker-compose.yml zum Toolkit

Migrieren Sie eine Overleaf-Bereitstellung mit Docker Compose zum Toolkit.

Wenn Sie derzeit Docker Compose über eine Datei docker-compose.yml verwenden, kann eine Migration zum Toolkit die Bereitstellung, Aktualisierung und Wartung einer selbst gehosteten Overleaf-Version vereinfachen.

Für die Migration müssen Sie Ihr bestehendes Docker-Compose-Setup in das vom Toolkit verwendete Format überführen. Dabei wird die vorhandene Konfiguration in das Toolkit übernommen.

Diese Anleitung führt Sie Schritt für Schritt durch diesen Prozess und sorgt für eine reibungslose Migration von Docker Compose zum Toolkit.

Diese Anleitung gilt für v4.x und früher. Daher verwenden alle Variablen das Präfix SHARELATEX_ statt OVERLEAF_.

1. Das Toolkit-Repository klonen

   Klonen Sie zunächst das Toolkit-Repository auf den Host-Rechner:

   git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
   

   Führen Sie anschließend den Befehl bin/init aus, um das Toolkit mit seiner Standardkonfiguration zu initialisieren.

2. Image und Version festlegen

   In einer typischen docker-compose.yml werden Image und Version in der Komponentenbeschreibung definiert, zum Beispiel:

   version: '2.2'
   services:
       sharelatex:
           restart: always
           # Server Pro users:
           # image: quay.io/sharelatex/sharelatex-pro
           image: sharelatex/sharelatex:3.5.13
   

   Bei Verwendung des Toolkits wird der Image-Name automatisch ermittelt; Sie müssen lediglich in config/overleaf.rc SERVER_PRO=true setzen, um das Server-Pro-Image zu verwenden, oder SERVER_PRO=false für die Community Edition.

   Die gewünschte Versionsnummer von Server Pro bzw. der Community Edition wird in der Datei config/version festgelegt. Das Toolkit benötigt eine konkrete Versionsnummer wie 4.2.3. Wenn Sie latest verwenden, können Sie mit bin/images die Image-ID Ihrer lokalen latest-Version ermitteln und diese anhand der Release Notes für 2.x.x, 3.x.x, 4.x.x oder 5.x.x einer Version zuordnen.

   Wenn Sie das Image aus Ihrer eigenen internen Registry beziehen, können Sie das vom Toolkit verwendete Image über OVERLEAF_IMAGE_NAME überschreiben. Den Tag müssen Sie nicht angeben, da das Toolkit ihn automatisch anhand Ihrer Datei config/version hinzufügt.

3. Externen Zugriff konfigurieren

   Standardmäßig lauscht Overleaf auf 127.0.0.1:80 und lässt nur Datenverkehr vom Docker-Host-Rechner zu.

   Um externen Zugriff zu erlauben, setzen Sie OVERLEAF_LISTEN_IP und OVERLEAF_PORT in der Datei config/overleaf.rc.

4. Umgebungsvariablen migrieren

   Wahrscheinlich haben Sie im Dienst sharelatex Ihrer docker-compose.yml eine Reihe von Umgebungsvariablen definiert, zum Beispiel:

   environment:
       OVERLEAF_APP_NAME: Overleaf Community Edition
       OVERLEAF_PROXY_LEARN: 'true'
       …
   

   Kopieren Sie diese Variablen in die Datei config/variables.env des Toolkits und verwenden Sie dabei die folgende Form (= statt :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Ausnahmen bzw. Unterschiede bei Verwendung des Toolkits:

   • Variablen, die mit SANDBOXED_COMPILES_ und DOCKER_RUNNER beginnen, werden nicht mehr benötigt. Um Sandboxed Compiles zu aktivieren, setzen Sie SIBLING_CONTAINERS_ENABLED=true in Ihrer Datei config/overleaf.rc.
   • Variablen, die mit OVERLEAF_MONGO_ und OVERLEAF_REDIS_ beginnen, sowie die Variable REDIS_HOST werden nicht mehr benötigt. MongoDB und Redis werden jetzt in der Datei config/overleaf.rc über MONGO_URL, REDIS_HOST und REDIS_PORT konfiguriert.

   Erweiterte Konfigurationsoptionen finden Sie in der Dokumentation zu config/overleaf.rc.

5. NGINX-Proxy

   Eine Anleitung zur Migration von nginx finden Sie in der Dokumentation zum TLS-Proxy:

6. Volumes

   Legen Sie die Speicherorte der Daten-Volumes in config/overleaf.rc fest:

   ​

   ShareLaTeX

   Setzen Sie OVERLEAF_DATA_PATH auf den Speicherort des Daten-Volumes, das vom Container sharelatex verwendet wird.

   ​

   MongoDB

   Setzen Sie MONGO_DATA_PATH auf den Speicherort des Daten-Volumes, das vom Container mongo verwendet wird.

   ​

   Redis

   Setzen Sie REDIS_DATA_PATH auf den Speicherort des Daten-Volumes, das vom Container redis verwendet wird.

Weitere Details und erweiterte Konfigurationsmöglichkeiten finden Sie in den oben verlinkten Dokumenten zur Toolkit-Konfiguration.