Saltar para o conteúdo principal
Esta página descreve os arquivos de configuração usados pelo Toolkit para configurar sua implantação on-premises do Overleaf.

Dados persistentes

O Overleaf Toolkit precisa armazenar dados persistentes, como os arquivos necessários para compilar projetos LaTeX e o conteúdo do banco de dados MongoDB. Isso é feito montando alguns diretórios da máquina host nos contêineres Docker e gravando os dados nesses diretórios.

Diretórios de dados

O contêiner sharelatex requer um diretório para armazenar dados relacionados às compilações LaTeX. Esse diretório é definido com a variável OVERLEAF_DATA_PATH em config/overleaf.rc. O contêiner mongo, se estiver ativado, requer um diretório para armazenar seus arquivos de banco de dados, e o mesmo vale para o contêiner redis. Esses diretórios também podem ser configurados em config/overleaf.rc.

Permissões de arquivos

Como o Docker é executado como root, os diretórios de dados acabarão pertencendo ao usuário root, mesmo que o Toolkit esteja sendo usado por um usuário não root. Isso não é um problema, mas vale a pena saber disso caso você pretenda alterar os dados persistentes fora dos contêineres.

Local dos arquivos de configuração

Todos os arquivos de configuração de propriedade do usuário ficam no diretório config/. Esse diretório é excluído do sistema de controle de versão git, portanto não será alterado ao atualizar o código do Toolkit. O Toolkit não alterará nenhum dado no diretório config/ sem a sua permissão.
Alterações nos arquivos de configuração não serão aplicadas automaticamente aos contêineres existentes, mesmo que o contêiner seja parado e reiniciado (com bin/stop e bin/start). Para aplicar as alterações, execute bin/up e, nos bastidores, o docker compose aplicará automaticamente as alterações de configuração a um novo contêiner. (Ou execute bin/up -d, se preferir não se conectar aos logs do Docker.)

O arquivo config/overleaf.rc

O arquivo config/overleaf.rc contém as configurações de nível superior mais importantes usadas pelo Toolkit. Ele contém instruções que definem variáveis, no formato: VARIABLE_NAME=value Para ver um detalhamento de todas as opções de configuração disponíveis, consulte nossa seção de configurações.

O arquivo variables.env

O arquivo config/variables.env contém variáveis de ambiente que são carregadas no contêiner sharelatex e usadas para configurar os microsserviços do Overleaf. Entre elas estão o nome da aplicação, exibido no cabeçalho da interface web, as configurações de envio de e-mails e outras configurações, como SSO. Para ver um detalhamento de todas as variáveis de ambiente disponíveis, consulte a seção Variáveis de ambiente.

O arquivo config/version

O arquivo config/version contém o número da versão da imagem Docker que será usada para criar a instância em execução do seu servidor Overleaf.
Alterações nesses arquivos de configuração não serão aplicadas automaticamente aos contêineres existentes, mesmo que o contêiner seja parado e reiniciado (com bin/stop e bin/start). Para aplicar suas alterações, execute bin/up, e o Toolkit criará automaticamente um novo contêiner para você com as alterações de configuração aplicadas.

O arquivo docker-compose.override.yml

Se presente, o arquivo config/docker-compose.override.yml será incluído na invocação do docker compose. Isso é útil para sobrescrever configurações específicas do Docker Compose. O config/variables.env não é carregado nos contêineres mongo e redis. Para definir uma variável de ambiente neles, adicione-a aqui e execute bin/up -d, por exemplo:
Consulte a documentação do docker-compose para mais detalhes.

Q&A

Resposta: O Toolkit não verifica o sistema de arquivos. Quem tem requisitos é o MongoDB, então a escolha importa principalmente para data/mongo (MONGO_DATA_PATH). As notas de produção do MongoDB recomendam usar XFS ou ext4 no Linux e recomendam fortemente o XFS com o WiredTiger, o mecanismo de armazenamento que ele usa. Elas não abordam o btrfs nem outros sistemas de arquivos copy-on-write. Se o seu sistema de arquivos raiz for btrfs, você pode montar um volume XFS e apontar MONGO_DATA_PATH para ele. O sistema de arquivos também deve oferecer suporte a fsync() em diretórios, o que as pastas compartilhadas do HGFS e do VirtualBox não oferecem.A compressão do sistema de arquivos economiza pouco para data/mongo: o WiredTiger já comprime as coleções com snappy e os índices com compressão de prefixo. Para NFS, consulte Solução de problemas.
Última modificação em 2 de novembro de 2026