Migrering fra docker-compose.yml til Toolkit

Migrer en Overleaf-distribusjon basert på Docker Compose til Toolkit.

Hvis du for øyeblikket bruker Docker Compose via en docker-compose.yml-fil, kan en migrering til Toolkit gjøre det enklere å distribuere, oppgradere og vedlikeholde en lokalt driftet versjon av Overleaf.

For å migrere må du konvertere det eksisterende Docker Compose-oppsettet til formatet som brukes av Toolkit. Denne prosessen innebærer å kopiere eksisterende konfigurasjon inn i Toolkit.

Denne veiledningen tar deg gjennom hvert trinn i prosessen og sikrer en smidig migrering fra Docker Compose til Toolkit.

Disse instruksjonene gjelder for v4.x og tidligere. Derfor bruker alle variabler prefikset SHARELATEX_ i stedet for OVERLEAF_.

1. Klone Toolkit-repositoriet

   Først kloner du Toolkit-repositoriet til vertsmaskinen:

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

   Kjør deretter kommandoen bin/init for å initialisere Toolkit med standardkonfigurasjonen.

2. Angi image og versjon

   I en typisk docker-compose.yml er image og versjon definert 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 bruker Toolkit, løses image-navnet automatisk; det eneste kravet er å angi SERVER_PRO=true i config/overleaf.rc for å velge Server Pro-imaget, eller SERVER_PRO=false for å bruke Community Edition.

   Ønsket versjonsnummer for Server Pro/Community Edition angis i filen config/version. Toolkit krever et bestemt versjonsnummer, som 4.2.3. Hvis du bruker latest, kan du bruke bin/images til å finne image-ID-en til din lokale latest-versjon, og deretter bruke utgivelsesnotatene for 2.x.x, 3.x.x, 4.x.x eller 5.x.x til å koble image-ID-en til versjonen.

   Hvis du henter imaget fra ditt eget interne register, kan du overstyre imaget som Toolkit bruker, ved å angi OVERLEAF_IMAGE_NAME. Du trenger ikke å angi taggen, siden Toolkit legger den til automatisk basert på filen config/version.

3. Konfigurere ekstern tilgang

   Som standard lytter Overleaf på 127.0.0.1:80, noe som bare tillater trafikk fra Docker-vertsmaskinen.

   For å tillate ekstern tilgang angir du OVERLEAF_LISTEN_IP og OVERLEAF_PORT i filen config/overleaf.rc.

4. Migrering av miljøvariabler

   Du har sannsynligvis et sett med miljøvariabler definert i tjenesten sharelatex i docker-compose.yml, for eksempel:

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

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

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Unntak / forskjeller ved bruk av Toolkit:

   • Variabler som starter med SANDBOXED_COMPILES_ og DOCKER_RUNNER, trengs ikke lenger. For å aktivere Sandboxed Compiles angir du SIBLING_CONTAINERS_ENABLED=true i filen config/overleaf.rc.
   • Variabler som starter med OVERLEAF_MONGO_, OVERLEAF_REDIS_ og variabelen REDIS_HOST trengs ikke lenger. MongoDB og Redis konfigureres nå i filen config/overleaf.rc ved hjelp av MONGO_URL, REDIS_HOST og REDIS_PORT.

   For avanserte konfigurasjonsalternativer, se dokumentasjonen for config/overleaf.rc.

5. NGINX-proxy

   For instruksjoner om hvordan du migrerer nginx, se dokumentasjonen for TLS-proxy:

6. Volumer

   Angi plasseringen av datavolumene i config/overleaf.rc:

   ​

   ShareLaTeX

   Sett OVERLEAF_DATA_PATH til plasseringen av datavolumet som brukes av containeren sharelatex.

   ​

   MongoDB

   Sett MONGO_DATA_PATH til plasseringen av datavolumet som brukes av containeren mongo.

   ​

   Redis

   Sett REDIS_DATA_PATH til plasseringen av datavolumet som brukes av containeren redis.

For flere detaljer og avansert konfigurasjon, se den relevante konfigurasjonsdokumentasjonen for Toolkit som det er lenket til ovenfor.