> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

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

## Contêiner

### `sharelatex`

| Nome | Descrição |
| - | - |
| `PROJECT_NAME` | <p>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.<br /><br />- <strong>Padrão</strong>: `overleaf`</p> |
| `OVERLEAF_IMAGE_NAME` | <p>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`.<br /><br />- <strong>Padrão:</strong><br />- Server Pro: `ghcr.io/ayaka-notes/overleaf-pro`<br />- Community Edition: `sharelatex/sharelatex`</p> |
| `SERVER_PRO` | <p>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`).<br /><br />- <strong>Padrão</strong>: `false`</p> |
| `GIT_BRIDGE_ENABLED` | <p>Defina como `true` para habilitar o recurso git-bridge (somente Server Pro). Para mais informações, consulte a documentação do usuário em <a href="https://www.overleaf.com/learn/how-to/Git_integration">[https://www.overleaf.com/learn/how-to/Git\_integration](https://www.overleaf.com/learn/how-to/Git_integration)</a>.<br /><br />- <strong>Padrão:</strong> `false`</p> |
| `GIT_BRIDGE_IMAGE` | <p>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`.<br /><br />- <strong>Padrão:</strong> `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`</p> |
| `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` | <p>Configura o nível de log do contêiner `git-bridge`. Níveis disponíveis: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.<br /><br />- <strong>Padrão:</strong> `INFO`</p> |
| `SIBLING_CONTAINERS_ENABLED` | <p>Quando definido como `true`, instrui o Toolkit a usar a técnica de <strong>Sibling Containers</strong> 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.<br /><br />- <strong>Requer:</strong> `SERVER_PRO=true`<br />- <strong>Padrão:</strong> `true`</p> |
| `SIBLING_CONTAINERS_PULL` | <p>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 <strong>config/variables.env</strong>.<br /><br />- <strong>Padrão:</strong> `true`</p> |
| `DOCKER_SOCKET_PATH` | <p>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.<br /><br />- <strong>Requer:</strong> `SIBLING_CONTAINERS_ENABLED=true`<br />- <strong>Padrão:</strong> `/var/run/docker.sock`</p> |
| `OVERLEAF_DATA_PATH` | <p>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.<br /><br />- <strong>Padrão:</strong> `data/overleaf`</p> |
| `OVERLEAF_LISTEN_IP` | <p>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 .<br /><br />- <strong>Padrão:</strong> `127.0.0.1`</p> |
| `OVERLEAF_PORT` | <p>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`.<br /><br />- <strong>Padrão:</strong> `80`</p> |
| `OVERLEAF_LOG_PATH` | <p>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.<br /><br />Consulte para obter informações sobre logs.<br /><br />- <strong>Padrão:</strong> não definido</p> |

***

### `mongo`

| Nome | Descrição |
| - | - |
| `MONGO_ENABLED` | <p>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`.<br /><br />- <strong>Padrão</strong>: `true`</p> |
| `MONGO_URL` | <p>Especifica a URL de conexão do MongoDB a ser usada quando `MONGO_ENABLED` for `false`.<br /><br />- <strong>Padrão</strong>: não definido</p> |
| `MONGO_DATA_PATH` | <p>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`.<br /><br />- <strong>Padrão</strong>: `data/mongo`</p> |
| `MONGO_IMAGE` | <p>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).<br /><br />- <strong>Padrão:</strong> `mongo`</p> |
| `MONGO_VERSION` | <p>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`.<br /><br />- <strong>Padrão:</strong> `6.0`</p> |

***

### `redis`

| Nome | Descrição |
| - | - |
| `REDIS_ENABLED` | <p>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`.<br /><br />- <strong>Padrão</strong>: `true`</p> |
| `REDIS_HOST` | <p>Especifica o host Redis a ser usado quando `REDIS_ENABLED` for `false`.<br /><br />- <strong>Padrão</strong>: não definido</p> |
| `REDIS_PORT` | <p>Especifica a porta do Redis a ser usada quando `REDIS_ENABLED` for `false`.<br /><br />- <strong>Padrão</strong>: não definido</p> |
| `REDIS_DATA_PATH` | <p>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`.<br /><br />- <strong>Padrão</strong>: `data/redis`</p> |
| `REDIS_AOF_PERSISTENCE` | <p>Ativa a persistência AOF (Append Only File) para o Redis. Esta é a configuração <strong>recomendada</strong> para a persistência do Redis.<br /><br />Para mais detalhes, consulte a seção \<../../../maintenance/data-and-backups#aof-append-only-file> em \<../../maintenance/data-and-backups>.<br /><br />- <strong>Padrão:</strong> `true`</p> |

***

### `nginx`

| Nome | Descrição |
| - | - |
| `NGINX_ENABLED` | <p>Quando definido como `true`, instrui o Toolkit a criar um contêiner NGINX para atuar como proxy TLS.<br /><br />- <strong>Padrão</strong>: `false`</p> |
| `NGINX_CONFIG_PATH` | <p>Caminho do arquivo de configuração do NGINX a ser usado pelo proxy TLS.<br /><br />- <strong>Padrão</strong>: `config/nginx/nginx.conf`</p> |
| `NGINX_TLS_LISTEN_IP` | <p>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.<br /><br />- <strong>Padrão</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_LISTEN_IP` | <p>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`.<br /><br />- <strong>Padrão</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_PORT` | <p>Define a porta do host à qual o contêiner do proxy TLS fará bind para HTTP.<br /><br />- <strong>Padrão</strong>: `80`</p> |
| `TLS_PORT` | <p>Define a porta do host à qual o contêiner do proxy TLS fará bind para HTTPS.<br /><br />- <strong>Padrão</strong>: `443`</p> |
| `TLS_PRIVATE_KEY_PATH` | <p>Caminho da chave privada a ser usada pelo proxy TLS.<br /><br />- <strong>Padrão</strong>: `config/nginx/certs/overleaf_key.pem`</p> |
| `TLS_CERTIFICATE_PATH` | <p>Caminho do certificado público a ser usado pelo proxy TLS.<br /><br />- <strong>Padrão</strong>: `config/nginx/certs/overleaf_certificate.pem`</p> |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.