Configurações do Toolkit

Esta página descreve as variáveis de ambiente suportadas no arquivo config/overleaf.rc em implantações com o Toolkit.

O arquivo config/overleaf.rc consiste em definições de variáveis no formato NAME=value. Linhas que começam com # são tratadas como comentários.

É necessário recriar os contêineres Docker executando bin/up após alterar qualquer coisa em overleaf.rc ou variables.env.

​

Contêiner

​

sharelatex

Nome	Descrição
PROJECT_NAME	Define o valor da flag --project-name passada ao docker-compose. Isso é útil ao executar várias instâncias do Overleaf em um único host, pois cada instância pode ter um nome de projeto diferente. - Padrão: overleaf
OVERLEAF_IMAGE_NAME	Imagem Docker usada pelo contêiner da aplicação Server Pro/CE. Este é apenas o nome da imagem Docker; a tag da imagem Docker é obtida de config/version. - Padrão: - Server Pro: ghcr.io/ayaka-notes/overleaf-pro - Community Edition: sharelatex/sharelatex
SERVER_PRO	Quando definido como true, instrui o Toolkit a usar a imagem do Server Pro (ghcr.io/ayaka-notes/overleaf-pro) em vez da imagem padrão do Server CE (sharelatex/sharelatex). - Padrão: false
GIT_BRIDGE_ENABLED	Defina como true para habilitar o recurso git-bridge (somente Server Pro). Para mais informações, consulte a documentação do usuário em https://www.overleaf.com/learn/how-to/Git_integration. - Padrão: false
GIT_BRIDGE_IMAGE	Imagem Docker usada pelo contêiner do git-bridge (somente Server Pro). Este é apenas o nome da imagem Docker; a tag da imagem Docker é obtida de config/version. - Padrão: ghcr.io/ayaka-notes/overleaf-pro/git-bridge
GIT_BRIDGE_DATA_PATH	Define o caminho do diretório que será montado no contêiner git-bridge (somente Server Pro) e usado para armazenar os repositórios git. Pode ser um caminho completo (começando com /) ou relativo ao diretório base do Toolkit.
GIT_BRIDGE_LOG_LEVEL	Configura o nível de log do contêiner git-bridge. Níveis disponíveis: TRACE, DEBUG, INFO, WARN, ERROR. - Padrão: INFO
SIBLING_CONTAINERS_ENABLED	Quando definido como true, instrui o Toolkit a usar a técnica de Sibling Containers para compilar projetos em sandboxes separadas, usando um contêiner Docker separado para cada projeto. Consulte a documentação <server-pro-only-configuration/sandboxed-compiles> para mais informações. - Requer: SERVER_PRO=true - Padrão: true
SIBLING_CONTAINERS_PULL	Quando definido como true, instrui o Toolkit a baixar automaticamente, ao usar o comando bin/up, todas as imagens do TeX Live definidas em ALL_TEX_LIVE_DOCKER_IMAGES no arquivo config/variables.env. - Padrão: true
DOCKER_SOCKET_PATH	Define o caminho do socket do Docker na máquina host (a máquina que executa o Toolkit). Quando SIBLING_CONTAINERS_ENABLED é true, o socket é montado no contêiner para permitir que o serviço de compilação crie novos contêineres Docker no host. - Requer: SIBLING_CONTAINERS_ENABLED=true - Padrão: /var/run/docker.sock
OVERLEAF_DATA_PATH	Define o caminho do diretório que será montado no contêiner principal sharelatex e usado para armazenar os dados de compilação. Pode ser um caminho completo (começando com /) ou relativo ao diretório base do Toolkit. - Padrão: data/overleaf
OVERLEAF_LISTEN_IP	Define o(s) endereço(s) IP do host aos quais o contêiner fará bind. Por exemplo, se for definido como 0.0.0.0, a interface web ficará disponível em qualquer endereço IP do host. Para acesso direto ao contêiner, o valor de OVERLEAF_LISTEN_IP deve ser definido como seu endereço IP público. Definir OVERLEAF_LISTEN_IP como 0.0.0.0 ou como o IP externo do seu host normalmente causará erros quando usado em conjunto com o . - Padrão: 127.0.0.1
OVERLEAF_PORT	Define a porta do host à qual o contêiner fará bind. Por exemplo, se for definida como 8099 e OVERLEAF_LISTEN_IP estiver definido como 127.0.0.1, a interface web ficará disponível em http://localhost:8099. - Padrão: 80
OVERLEAF_LOG_PATH	Define o caminho do diretório que será montado no contêiner principal sharelatex e usado para disponibilizar os logs da aplicação no host Docker. Pode ser um caminho completo (começando com /) ou relativo ao diretório base do Toolkit. Remova a entrada de configuração para desabilitar o bind-mount. Quando não definido, os logs serão descartados ao recriar o contêiner. Consulte para obter informações sobre logs. - Padrão: não definido

---

​

mongo

Nome	Descrição
MONGO_ENABLED	Quando definido como true, instrui o Toolkit a criar um contêiner MongoDB para hospedar o banco de dados. Quando definido como false, esse contêiner não será criado e o sistema usará o banco de dados MongoDB especificado por MONGO_URL. - Padrão: true
MONGO_URL	Especifica a URL de conexão do MongoDB a ser usada quando MONGO_ENABLED for false. - Padrão: não definido
MONGO_DATA_PATH	Define o caminho do diretório que será montado no contêiner mongo e usado para armazenar o banco de dados MongoDB. Pode ser um caminho completo (começando com /) ou relativo ao diretório base do Toolkit. Esta opção afeta apenas o contêiner mongo local criado quando MONGO_ENABLED é true. - Padrão: data/mongo
MONGO_IMAGE	Imagem Docker usada pelo contêiner MongoDB. Este é apenas o nome da imagem Docker; a tag da imagem Docker deve ir em MONGO_VERSION (veja abaixo). - Padrão: mongo
MONGO_VERSION	Versão do MongoDB usada pelo contêiner MongoDB. O valor deve começar com a versão principal do MongoDB e um ponto, por exemplo 6.0 ou 6.0-with-suffix. - Padrão: 6.0

---

​

redis

Nome	Descrição
REDIS_ENABLED	Quando definido como true, instrui o Toolkit a criar um contêiner Redis para hospedar o banco de dados Redis. Quando definido como false, esse contêiner não será criado e o sistema usará o banco de dados Redis especificado por REDIS_HOST e REDIS_PORT. - Padrão: true
REDIS_HOST	Especifica o host Redis a ser usado quando REDIS_ENABLED for false. - Padrão: não definido
REDIS_PORT	Especifica a porta do Redis a ser usada quando REDIS_ENABLED for false. - Padrão: não definido
REDIS_DATA_PATH	Define o caminho do diretório que será montado no contêiner redis e usado para armazenar o banco de dados Redis. Pode ser um caminho completo (começando com /) ou relativo ao diretório base do Toolkit. Esta opção afeta apenas o contêiner redis local criado quando REDIS_ENABLED é true. - Padrão: data/redis
REDIS_AOF_PERSISTENCE	Ativa a persistência AOF (Append Only File) para o Redis. Esta é a configuração recomendada para a persistência do Redis. Para mais detalhes, consulte a seção <../../../maintenance/data-and-backups#aof-append-only-file> em <../../maintenance/data-and-backups>. - Padrão: true

---

​

nginx

Nome	Descrição
NGINX_ENABLED	Quando definido como true, instrui o Toolkit a criar um contêiner NGINX para atuar como proxy TLS. - Padrão: false
NGINX_CONFIG_PATH	Caminho do arquivo de configuração do NGINX a ser usado pelo proxy TLS. - Padrão: config/nginx/nginx.conf
NGINX_TLS_LISTEN_IP	Define o(s) endereço(s) IP do host aos quais o contêiner do proxy TLS fará bind para HTTPS. Por exemplo, se for definido como 0.0.0.0, a interface web HTTPS ficará disponível em qualquer endereço IP do host. Normalmente, deve ser definido como o IP externo do seu host. - Padrão: 127.0.1.1
NGINX_HTTP_LISTEN_IP	Define o(s) endereço(s) IP do host aos quais o contêiner do proxy TLS fará bind para o redirecionamento HTTP. Por exemplo, se for definido como 127.0.1.1, as conexões HTTP para 127.0.1.1 serão redirecionadas para a interface web HTTPS. Normalmente, deve ser definido como o IP externo do seu host. Não o defina como 0.0.0.0, pois isso normalmente causará conflito com OVERLEAF_LISTEN_IP. - Padrão: 127.0.1.1
NGINX_HTTP_PORT	Define a porta do host à qual o contêiner do proxy TLS fará bind para HTTP. - Padrão: 80
TLS_PORT	Define a porta do host à qual o contêiner do proxy TLS fará bind para HTTPS. - Padrão: 443
TLS_PRIVATE_KEY_PATH	Caminho da chave privada a ser usada pelo proxy TLS. - Padrão: config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH	Caminho do certificado público a ser usado pelo proxy TLS. - Padrão: config/nginx/certs/overleaf_certificate.pem