Migrace z docker-compose.yml na Toolkit

Migrace nasazení Overleafu přes Docker Compose na Toolkit.

Pokud v současnosti používáte Docker Compose prostřednictvím souboru docker-compose.yml, migrace na Toolkit může usnadnit nasazení, upgrade a údržbu on-premises verze Overleafu.

Pro migraci je potřeba převést stávající nastavení Docker Compose do formátu, který používá Toolkit. Tento proces zahrnuje zkopírování stávající konfigurace do Toolkitu.

Tento návod vás provede každým krokem tohoto procesu a zajistí hladkou migraci z Docker Compose na Toolkit.

Tyto pokyny platí pro verzi v4.x a starší. Všechny proměnné proto používají předponu SHARELATEX_ místo OVERLEAF_.

1. Naklonování repozitáře Toolkitu

   Nejprve naklonujte repozitář Toolkitu na hostitelský počítač:

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

   Poté spusťte příkaz bin/init, který Toolkit inicializuje s výchozí konfigurací.

2. Nastavení image a verze

   V typickém souboru docker-compose.yml jsou image a verze definovány v popisu komponenty, například:

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

   Při použití Toolkitu se název image určí automaticky; jediným požadavkem je nastavit v config/overleaf.rc SERVER_PRO=true pro výběr image Server Pro, nebo SERVER_PRO=false pro použití Community Edition.

   Požadované číslo verze Server Pro/Community Edition se nastavuje v souboru config/version. Toolkit vyžaduje konkrétní číslo verze, například 4.2.3. Pokud používáte latest, můžete pomocí bin/images zjistit ID image vaší lokální verze latest a poté podle poznámek k vydání 2.x.x, 3.x.x, 4.x.x nebo 5.x.x přiřadit ID image ke konkrétní verzi.

   Pokud image získáváte z vlastního interního registru, můžete image používaný Toolkitem přepsat nastavením OVERLEAF_IMAGE_NAME. Tag není nutné uvádět, protože jej Toolkit automaticky doplní podle vašeho souboru config/version.

3. Konfigurace externího přístupu

   Ve výchozím nastavení Overleaf naslouchá na 127.0.0.1:80 a povoluje pouze provoz z hostitelského počítače Dockeru.

   Pro povolení externího přístupu nastavte OVERLEAF_LISTEN_IP a OVERLEAF_PORT v souboru config/overleaf.rc.

4. Migrace proměnných prostředí

   Pravděpodobně máte ve službě sharelatex v souboru docker-compose.yml definovánu sadu proměnných prostředí, například:

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

   Zkopírujte tyto proměnné do souboru Toolkitu config/variables.env v následujícím tvaru (použijte = místo :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Výjimky / rozdíly při použití Toolkitu:

   • Proměnné začínající na SANDBOXED_COMPILES_ a DOCKER_RUNNER již nejsou potřeba. Chcete-li povolit Sandboxed Compiles, nastavte v souboru config/overleaf.rc SIBLING_CONTAINERS_ENABLED=true.
   • Proměnné začínající na OVERLEAF_MONGO_, OVERLEAF_REDIS_ a proměnná REDIS_HOST již nejsou potřeba. MongoDB a Redis se nyní konfigurují v souboru config/overleaf.rc pomocí MONGO_URL, REDIS_HOST a REDIS_PORT.

   Pokročilé možnosti konfigurace najdete v dokumentaci config/overleaf.rc.

5. NGINX proxy

   Pokyny k migraci nginx najdete v dokumentaci TLS proxy:

6. Svazky

   Nastavte umístění datových svazků v config/overleaf.rc:

   ​

   ShareLaTeX

   Nastavte OVERLEAF_DATA_PATH na umístění datového svazku používaného kontejnerem sharelatex.

   ​

   MongoDB

   Nastavte MONGO_DATA_PATH na umístění datového svazku používaného kontejnerem mongo.

   ​

   Redis

   Nastavte REDIS_DATA_PATH na umístění datového svazku používaného kontejnerem redis.

Další podrobnosti a pokročilou konfiguraci najdete v příslušné dokumentaci ke konfiguraci Toolkitu, na kterou odkazujeme výše.