Migratie van docker-compose.yml naar de Toolkit

Migreer een Overleaf-deployment met Docker Compose naar de Toolkit.

Als je momenteel Docker Compose gebruikt via een bestand docker-compose.yml, kan een migratie naar de Toolkit het eenvoudiger maken om een on-premises versie van Overleaf te deployen, te upgraden en te onderhouden.

Om te migreren moet je je bestaande Docker Compose-opstelling omzetten naar het formaat dat de Toolkit gebruikt. Dit houdt in dat je de bestaande configuratie naar de Toolkit kopieert.

Deze handleiding leidt je stap voor stap door dit proces, zodat de migratie van Docker Compose naar de Toolkit soepel verloopt.

Deze instructies gelden voor v4.x en eerder. Daarom gebruiken alle variabelen het voorvoegsel SHARELATEX_ in plaats van OVERLEAF_.

1. De Toolkit-repository klonen

   Kloon eerst de Toolkit-repository naar de hostmachine:

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

   Voer daarna de opdracht bin/init uit om de Toolkit met de standaardconfiguratie te initialiseren.

2. De image en versie instellen

   In een typisch docker-compose.yml-bestand worden de image en versie gedefinieerd in de componentbeschrijving, bijvoorbeeld:

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

   Bij gebruik van de Toolkit wordt de imagenaam automatisch bepaald; je hoeft alleen SERVER_PRO=true in config/overleaf.rc in te stellen om de Server Pro-image te kiezen, of SERVER_PRO=false om Community Edition te gebruiken.

   Het gewenste versienummer van Server Pro/Community Edition wordt ingesteld in het bestand config/version. De Toolkit vereist een specifiek versienummer zoals 4.2.3. Als je latest gebruikt, kun je met bin/images de image-id van je lokale latest-versie opzoeken en vervolgens de release notes voor 2.x.x, 3.x.x, 4.x.x of 5.x.x gebruiken om de image-id aan de versie te koppelen.

   Als je de image uit je eigen interne registry haalt, kun je de image die de Toolkit gebruikt overschrijven door OVERLEAF_IMAGE_NAME in te stellen. Je hoeft de tag niet op te geven, omdat de Toolkit die automatisch toevoegt op basis van je bestand config/version.

3. Externe toegang configureren

   Standaard luistert Overleaf op 127.0.0.1:80, waardoor alleen verkeer vanaf de Docker-hostmachine wordt toegestaan.

   Om externe toegang toe te staan, stel je OVERLEAF_LISTEN_IP en OVERLEAF_PORT in het bestand config/overleaf.rc in.

4. Migratie van omgevingsvariabelen

   Waarschijnlijk heb je een reeks omgevingsvariabelen gedefinieerd in de service sharelatex in je docker-compose.yml, bijvoorbeeld:

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

   Kopieer deze variabelen naar het bestand config/variables.env van de Toolkit, in de volgende vorm (gebruik = in plaats van :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Uitzonderingen / verschillen bij gebruik van de Toolkit:

   • Variabelen die beginnen met SANDBOXED_COMPILES_ en DOCKER_RUNNER zijn niet meer nodig. Om Sandboxed Compiles in te schakelen, stel je SIBLING_CONTAINERS_ENABLED=true in je bestand config/overleaf.rc in.
   • Variabelen die beginnen met OVERLEAF_MONGO_ en OVERLEAF_REDIS_, en de variabele REDIS_HOST, zijn niet meer nodig. MongoDB en Redis worden nu geconfigureerd in het bestand config/overleaf.rc met MONGO_URL, REDIS_HOST en REDIS_PORT.

   Raadpleeg voor geavanceerde configuratieopties de documentatie van config/overleaf.rc.

5. NGINX-proxy

   Zie de documentatie over de TLS-proxy voor instructies over het migreren van nginx:

6. Volumes

   Stel de locaties van de datavolumes in config/overleaf.rc in:

   ​

   ShareLaTeX

   Stel OVERLEAF_DATA_PATH in op de locatie van het datavolume dat door de container sharelatex wordt gebruikt.

   ​

   MongoDB

   Stel MONGO_DATA_PATH in op de locatie van het datavolume dat door de container mongo wordt gebruikt.

   ​

   Redis

   Stel REDIS_DATA_PATH in op de locatie van het datavolume dat door de container redis wordt gebruikt.

Raadpleeg voor meer details en geavanceerde configuratie de relevante configuratiedocumentatie van de Toolkit waarnaar hierboven wordt verwezen.