Migrering från docker-compose.yml till Toolkit

Migrera en Overleaf-driftsättning med Docker Compose till Toolkit.

Om du för närvarande använder Docker Compose via en docker-compose.yml-fil kan en migrering till Toolkit göra det enklare att driftsätta, uppgradera och underhålla en lokalt driftsatt version av Overleaf.

För att migrera behöver du konvertera din befintliga Docker Compose-konfiguration till det format som Toolkit använder. Processen innebär att befintlig konfiguration kopieras till Toolkit.

Den här guiden tar dig igenom varje steg i processen och säkerställer en smidig migrering från Docker Compose till Toolkit.

Dessa instruktioner gäller v4.x och tidigare. Därför använder alla variabler prefixet SHARELATEX_ i stället för OVERLEAF_.

1. Klona Toolkit-repositoriet

   Klona först Toolkit-repositoriet till värddatorn:

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

   Kör sedan kommandot bin/init för att initiera Toolkit med dess standardkonfiguration.

2. Ange avbildning och version

   I en typisk docker-compose.yml definieras avbildningen och versionen i komponentbeskrivningen, till exempel:

   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 använder Toolkit löses avbildningens namn upp automatiskt; det enda kravet är att ange SERVER_PRO=true i config/overleaf.rc för att välja Server Pro-avbildningen eller SERVER_PRO=false för att använda Community Edition.

   Det önskade versionsnumret för Server Pro/Community Edition anges i filen config/version. Toolkit kräver ett specifikt versionsnummer som 4.2.3. Om du använder latest kan du använda bin/images för att hitta avbildnings-id:t för din lokala latest-version och sedan använda versionsinformationen för 2.x.x, 3.x.x, 4.x.x eller 5.x.x för att koppla avbildnings-id:t till versionen.

   Om du hämtar avbildningen från ditt eget interna register kan du åsidosätta avbildningen som Toolkit använder genom att ange OVERLEAF_IMAGE_NAME. Du behöver inte ange taggen, eftersom Toolkit lägger till den automatiskt baserat på din config/version-fil.

3. Konfigurera extern åtkomst

   Som standard lyssnar Overleaf på 127.0.0.1:80 och tillåter endast trafik från Docker-värddatorn.

   För att tillåta extern åtkomst, ange OVERLEAF_LISTEN_IP och OVERLEAF_PORT i filen config/overleaf.rc.

4. Migrering av miljövariabler

   Du har troligen en uppsättning miljövariabler definierade i tjänsten sharelatex i din docker-compose.yml, till exempel:

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

   Kopiera dessa variabler till Toolkits fil config/variables.env och se till att de har följande form (använd = i stället för :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Undantag/skillnader när du använder Toolkit:

   • Variabler som börjar med SANDBOXED_COMPILES_ och DOCKER_RUNNER behövs inte längre. För att aktivera Sandboxed Compiles, ange SIBLING_CONTAINERS_ENABLED=true i din config/overleaf.rc-fil.
   • Variabler som börjar med OVERLEAF_MONGO_, OVERLEAF_REDIS_ och variabeln REDIS_HOST behövs inte längre. MongoDB och Redis konfigureras nu i filen config/overleaf.rc med MONGO_URL, REDIS_HOST och REDIS_PORT.

   För avancerade konfigurationsalternativ, se dokumentationen för config/overleaf.rc.

5. NGINX-proxy

   Instruktioner för hur du migrerar nginx finns i dokumentationen för TLS-proxy:

6. Volymer

   Ange platserna för datavolymerna i config/overleaf.rc:

   ​

   ShareLaTeX

   Ange OVERLEAF_DATA_PATH till platsen för den datavolym som används av containern sharelatex.

   ​

   MongoDB

   Ange MONGO_DATA_PATH till platsen för den datavolym som används av containern mongo.

   ​

   Redis

   Ange REDIS_DATA_PATH till platsen för den datavolym som används av containern redis.

Mer information och avancerad konfiguration finns i de relevanta konfigurationsdokumenten för Toolkit som länkas ovan.