Migrazione da docker-compose.yml al Toolkit

Migra un deployment Docker Compose di Overleaf al Toolkit.

Se attualmente usi Docker Compose tramite un file docker-compose.yml, la migrazione al Toolkit può rendere più semplice il deployment, l’aggiornamento e la manutenzione di una versione on-premises di Overleaf.

Per eseguire la migrazione, dovrai convertire la tua configurazione Docker Compose esistente nel formato usato dal Toolkit. Questo processo prevede la copia della configurazione esistente nel Toolkit.

Questa guida ti accompagnerà in ogni fase del processo, garantendo una migrazione senza intoppi da Docker Compose al Toolkit.

Queste istruzioni si riferiscono alla v4.x e precedenti. Pertanto tutte le variabili usano il prefisso SHARELATEX_ invece di OVERLEAF_.

1. Clonare il repository del Toolkit

   Per prima cosa, clona il repository del Toolkit sulla macchina host:

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

   Quindi esegui il comando bin/init per inizializzare il Toolkit con la sua configurazione predefinita.

2. Impostare l'immagine e la versione

   In un tipico docker-compose.yml, l’immagine e la versione sono definite nella descrizione del componente, ad esempio:

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

   Quando usi il Toolkit, il nome dell’immagine viene risolto automaticamente; l’unico requisito è impostare SERVER_PRO=true in config/overleaf.rc per scegliere l’immagine Server Pro oppure SERVER_PRO=false per usare la Community Edition.

   Il numero di versione desiderato di Server Pro/Community Edition si imposta nel file config/version. Il Toolkit richiede un numero di versione specifico, come 4.2.3. Se usi latest, puoi usare bin/images per trovare l’ID dell’immagine della tua versione locale latest, quindi usare le note di rilascio per 2.x.x, 3.x.x, 4.x.x o 5.x.x per associare l’ID dell’immagine alla versione.

   Se scarichi l’immagine dal tuo registry interno, puoi sovrascrivere l’immagine usata dal Toolkit impostando OVERLEAF_IMAGE_NAME. Non è necessario specificare il tag, poiché il Toolkit lo aggiungerà automaticamente in base al tuo file config/version.

3. Configurare l'accesso esterno

   Per impostazione predefinita, Overleaf è in ascolto su 127.0.0.1:80, consentendo solo il traffico proveniente dalla macchina host Docker.

   Per consentire l’accesso esterno, imposta OVERLEAF_LISTEN_IP e OVERLEAF_PORT nel file config/overleaf.rc.

4. Migrazione delle variabili d'ambiente

   Probabilmente avrai un insieme di variabili d’ambiente definite nel servizio sharelatex del tuo docker-compose.yml, ad esempio:

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

   Copia queste variabili nel file config/variables.env del Toolkit, rispettando il formato seguente (usa = invece di :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Eccezioni / differenze quando usi il Toolkit:

   • Le variabili che iniziano con SANDBOXED_COMPILES_ e DOCKER_RUNNER non sono più necessarie. Per abilitare le Sandboxed Compiles, imposta SIBLING_CONTAINERS_ENABLED=true nel tuo file config/overleaf.rc.
   • Le variabili che iniziano con OVERLEAF_MONGO_, OVERLEAF_REDIS_ e la variabile REDIS_HOST non sono più necessarie. MongoDB e Redis ora si configurano nel file config/overleaf.rc tramite MONGO_URL, REDIS_HOST e REDIS_PORT.

   Per le opzioni di configurazione avanzate, consulta la documentazione di config/overleaf.rc.

5. Proxy NGINX

   Per istruzioni su come migrare nginx, consulta la documentazione del proxy TLS:

6. Volumi

   Imposta le posizioni dei volumi di dati in config/overleaf.rc:

   ​

   ShareLaTeX

   Imposta OVERLEAF_DATA_PATH sulla posizione del volume di dati usato dal container sharelatex.

   ​

   MongoDB

   Imposta MONGO_DATA_PATH sulla posizione del volume di dati usato dal container mongo.

   ​

   Redis

   Imposta REDIS_DATA_PATH sulla posizione del volume di dati usato dal container redis.

Per maggiori dettagli e per la configurazione avanzata, consulta la documentazione di configurazione del Toolkit indicata sopra.