Migración de docker-compose.yml al Toolkit

Migra un despliegue de Overleaf con Docker Compose al Toolkit.

Si actualmente usas Docker Compose mediante un archivo docker-compose.yml, migrar al Toolkit puede hacer que una versión local (on-premises) de Overleaf sea más fácil de desplegar, actualizar y mantener.

Para migrar, tendrás que convertir tu configuración actual de Docker Compose al formato que usa el Toolkit. Este proceso implica copiar la configuración existente en el Toolkit.

Esta guía te acompañará en cada paso de este proceso, garantizando una migración fluida de Docker Compose al Toolkit.

Estas instrucciones son para la v4.x y anteriores. Por lo tanto, todas las variables usan el prefijo SHARELATEX_ en lugar de OVERLEAF_.

1. Clonar el repositorio del Toolkit

   Primero, clona el repositorio del Toolkit en la máquina host:

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

   A continuación, ejecuta el comando bin/init para inicializar el Toolkit con su configuración predeterminada.

2. Establecer la imagen y la versión

   En un docker-compose.yml típico, la imagen y la versión se definen en la descripción del componente, por ejemplo:

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

   Al usar el Toolkit, el nombre de la imagen se resuelve automáticamente; el único requisito es establecer SERVER_PRO=true en config/overleaf.rc para elegir la imagen de Server Pro o SERVER_PRO=false para usar Community Edition.

   El número de versión deseado de Server Pro/Community Edition se establece en el archivo config/version. El Toolkit requiere un número de versión concreto, como 4.2.3. Si usas latest, puedes usar bin/images para encontrar el ID de imagen de tu versión latest local y, después, usar las notas de la versión 2.x.x, 3.x.x, 4.x.x o 5.x.x para asociar el ID de imagen con la versión.

   Si obtienes la imagen de tu propio registro interno, puedes sustituir la imagen que usa el Toolkit estableciendo OVERLEAF_IMAGE_NAME. No necesitas especificar la etiqueta, ya que el Toolkit la añadirá automáticamente según tu archivo config/version.

3. Configurar el acceso externo

   De forma predeterminada, Overleaf escuchará en 127.0.0.1:80, permitiendo solo el tráfico desde la máquina host de Docker.

   Para permitir el acceso externo, establece OVERLEAF_LISTEN_IP y OVERLEAF_PORT en el archivo config/overleaf.rc.

4. Migración de las variables de entorno

   Probablemente tengas un conjunto de variables de entorno definidas en el servicio sharelatex de tu docker-compose.yml, por ejemplo:

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

   Copia estas variables en el archivo config/variables.env del Toolkit, con el siguiente formato (usa = en lugar de :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Excepciones / diferencias al usar el Toolkit:

   • Las variables que empiezan por SANDBOXED_COMPILES_ y DOCKER_RUNNER ya no son necesarias. Para habilitar las Sandboxed Compiles, establece SIBLING_CONTAINERS_ENABLED=true en tu archivo config/overleaf.rc.
   • Las variables que empiezan por OVERLEAF_MONGO_, OVERLEAF_REDIS_ y la variable REDIS_HOST ya no son necesarias. MongoDB y Redis ahora se configuran en el archivo config/overleaf.rc mediante MONGO_URL, REDIS_HOST y REDIS_PORT.

   Para opciones de configuración avanzadas, consulta la documentación de config/overleaf.rc.

5. Proxy NGINX

   Para obtener instrucciones sobre cómo migrar nginx, consulta la documentación del proxy TLS:

6. Volúmenes

   Establece las ubicaciones de los volúmenes de datos en config/overleaf.rc:

   ​

   ShareLaTeX

   Establece OVERLEAF_DATA_PATH con la ubicación del volumen de datos que usa el contenedor sharelatex.

   ​

   MongoDB

   Establece MONGO_DATA_PATH con la ubicación del volumen de datos que usa el contenedor mongo.

   ​

   Redis

   Establece REDIS_DATA_PATH con la ubicación del volumen de datos que usa el contenedor redis.

Para más detalles y configuración avanzada, consulta la documentación de configuración del Toolkit correspondiente enlazada arriba.