Migração de docker-compose.yml para o Toolkit

Migre uma implantação do Overleaf com Docker Compose para o Toolkit.

Se você usa atualmente o Docker Compose por meio de um arquivo docker-compose.yml, migrar para o Toolkit pode tornar a versão on-premises do Overleaf mais fácil de implantar, atualizar e manter.

Para migrar, você precisará converter sua configuração existente do Docker Compose para o formato usado pelo Toolkit. Esse processo envolve copiar a configuração existente para o Toolkit.

Este guia conduzirá você por cada etapa desse processo, garantindo uma migração tranquila do Docker Compose para o Toolkit.

Estas instruções se aplicam à v4.x e anteriores. Portanto, todas as variáveis usam o prefixo SHARELATEX_ em vez de OVERLEAF_.

1. Clonar o repositório do Toolkit

   Primeiro, clone o repositório do Toolkit na máquina host:

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

   Em seguida, execute o comando bin/init para inicializar o Toolkit com sua configuração padrão.

2. Definindo a imagem e a versão

   Em um docker-compose.yml típico, a imagem e a versão são definidas na descrição do componente, por exemplo:

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

   Ao usar o Toolkit, o nome da imagem é resolvido automaticamente; o único requisito é definir SERVER_PRO=true em config/overleaf.rc para escolher a imagem do Server Pro ou SERVER_PRO=false para usar o Community Edition.

   O número da versão desejada do Server Pro/Community Edition é definido no arquivo config/version. O Toolkit exige um número de versão específico, como 4.2.3. Se você estiver usando latest, pode usar bin/images para encontrar o ID da imagem da sua versão latest local e, em seguida, usar as notas de versão 2.x.x, 3.x.x, 4.x.x ou 5.x.x para associar o ID da imagem à versão.

   Se você obtém a imagem do seu próprio registro interno, pode substituir a imagem usada pelo Toolkit definindo OVERLEAF_IMAGE_NAME. Não é necessário especificar a tag, pois o Toolkit a adicionará automaticamente com base no seu arquivo config/version.

3. Configurando o acesso externo

   Por padrão, o Overleaf escuta em 127.0.0.1:80, permitindo apenas tráfego da máquina host do Docker.

   Para permitir o acesso externo, defina OVERLEAF_LISTEN_IP e OVERLEAF_PORT no arquivo config/overleaf.rc.

4. Migração das variáveis de ambiente

   Provavelmente você tem um conjunto de variáveis de ambiente definidas no serviço sharelatex do seu docker-compose.yml, por exemplo:

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

   Copie essas variáveis para o arquivo config/variables.env do Toolkit, seguindo o formato abaixo (use = em vez de :):

   OVERLEAF_APP_NAME=Overleaf Community Edition
   OVERLEAF_PROXY_LEARN=true
   

   Exceções / diferenças ao usar o Toolkit:

   • Variáveis que começam com SANDBOXED_COMPILES_ e DOCKER_RUNNER não são mais necessárias. Para habilitar as Sandboxed Compiles, defina SIBLING_CONTAINERS_ENABLED=true no seu arquivo config/overleaf.rc.
   • Variáveis que começam com OVERLEAF_MONGO_, OVERLEAF_REDIS_ e a variável REDIS_HOST não são mais necessárias. MongoDB e Redis agora são configurados no arquivo config/overleaf.rc usando MONGO_URL, REDIS_HOST e REDIS_PORT.

   Para opções de configuração avançadas, consulte a documentação de config/overleaf.rc.

5. Proxy NGINX

   Para instruções sobre como migrar o nginx, consulte a documentação do proxy TLS:

6. Volumes

   Defina os locais dos volumes de dados em config/overleaf.rc:

   ​

   ShareLaTeX

   Defina OVERLEAF_DATA_PATH com o local do volume de dados usado pelo contêiner sharelatex.

   ​

   MongoDB

   Defina MONGO_DATA_PATH com o local do volume de dados usado pelo contêiner mongo.

   ​

   Redis

   Defina REDIS_DATA_PATH com o local do volume de dados usado pelo contêiner redis.

Para mais detalhes e configurações avançadas, consulte a documentação de configuração do Toolkit indicada acima.