Migrering fra docker-compose.yml til Toolkit

Migrer en Overleaf-installation baseret på Docker Compose til Toolkit.

Hvis du i øjeblikket bruger Docker Compose via en docker-compose.yml-fil, kan en migrering til Toolkit gøre det lettere at udrulle, opgradere og vedligeholde en on-premises-version af Overleaf.

For at migrere skal du konvertere din eksisterende Docker Compose-opsætning til det format, som Toolkit bruger. Processen indebærer, at den eksisterende konfiguration kopieres ind i Toolkit.

Denne vejledning fører dig gennem hvert trin i processen og sikrer en problemfri migrering fra Docker Compose til Toolkit.

Denne vejledning gælder for v4.x og tidligere. Derfor bruger alle variabler præfikset SHARELATEX_ i stedet for OVERLEAF_.

1. Klon Toolkit-repositoriet

   Klon først Toolkit-repositoriet til værtsmaskinen:

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

   Kør derefter kommandoen bin/init for at initialisere Toolkit med standardkonfigurationen.

2. Angivelse af image og version

   I en typisk docker-compose.yml er image og version defineret i komponentbeskrivelsen, for eksempel:

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

   Når du bruger Toolkit, opløses imagenavnet automatisk; det eneste krav er at angive SERVER_PRO=true i config/overleaf.rc for at vælge Server Pro-imaget eller SERVER_PRO=false for at bruge Community Edition.

   Det ønskede versionsnummer for Server Pro/Community Edition angives i filen config/version. Toolkit kræver et specifikt versionsnummer som 4.2.3. Hvis du bruger latest, kan du bruge bin/images til at finde image-id’et for din lokale latest-version og derefter bruge udgivelsesnoterne for 2.x.x, 3.x.x, 4.x.x eller 5.x.x til at matche image-id’et med versionen.

   Hvis du henter imaget fra dit eget interne registry, kan du tilsidesætte det image, Toolkit bruger, ved at angive OVERLEAF_IMAGE_NAME. Du behøver ikke angive tagget, da Toolkit automatisk tilføjer det baseret på din config/version-fil.

3. Konfiguration af ekstern adgang

   Som standard lytter Overleaf på 127.0.0.1:80 og tillader kun trafik fra Docker-værtsmaskinen.

   For at tillade ekstern adgang skal du angive OVERLEAF_LISTEN_IP og OVERLEAF_PORT i filen config/overleaf.rc.

4. Migrering af miljøvariabler

   Du har sandsynligvis et sæt miljøvariabler defineret i tjenesten sharelatex i din docker-compose.yml, for eksempel:

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

   Kopier disse variabler ind i Toolkits fil config/variables.env, og sørg for følgende form (brug = i stedet for :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Undtagelser/forskelle ved brug af Toolkit:

   • Variabler, der starter med SANDBOXED_COMPILES_ og DOCKER_RUNNER, er ikke længere nødvendige. For at aktivere Sandboxed Compiles skal du angive SIBLING_CONTAINERS_ENABLED=true i din config/overleaf.rc-fil.
   • Variabler, der starter med OVERLEAF_MONGO_ og OVERLEAF_REDIS_, samt variablen REDIS_HOST er ikke længere nødvendige. MongoDB og Redis konfigureres nu i filen config/overleaf.rc ved hjælp af MONGO_URL, REDIS_HOST og REDIS_PORT.

   For avancerede konfigurationsmuligheder henvises til dokumentationen for config/overleaf.rc.

5. NGINX-proxy

   For vejledning i, hvordan du migrerer nginx, se dokumentationen for TLS-proxy:

6. Volumener

   Angiv placeringen af datavolumener i config/overleaf.rc:

   ​

   ShareLaTeX

   Sæt OVERLEAF_DATA_PATH til placeringen af det datavolumen, som containeren sharelatex bruger.

   ​

   MongoDB

   Sæt MONGO_DATA_PATH til placeringen af det datavolumen, som containeren mongo bruger.

   ​

   Redis

   Sæt REDIS_DATA_PATH til placeringen af det datavolumen, som containeren redis bruger.

For flere detaljer og avanceret konfiguration henvises til den relevante Toolkit-konfigurationsdokumentation, der er linket til ovenfor.