> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/pt/configuracao/overleaf-toolkit/environment-variables.md). # Variáveis de ambiente Esta página descreve as variáveis de ambiente suportadas no `config/variables.env` ficheiro para implementações do Toolkit. O `config/variables.env` ficheiro consiste em definições de variáveis na forma `NAME=value`; as linhas que começam com `#` são tratadas como comentários. {% hint style="info" %} É necessário que recrie os contentores Docker após alterar qualquer coisa em `overleaf.rc` ou `variables.env` ao executar `bin/up`. {% endhint %} ### Todas as versões Estas variáveis de ambiente são compatíveis com Server CE e Server Pro e fornecem um caminho de migração fácil entre estas duas versões on-premise. Também podem ser usadas com implementações Toolkit e Docker Compose. {% hint style="info" %} Anteriormente, estas variáveis de ambiente tinham o prefixo `SHARELATEX_` em vez de `OVERLEAF_`. {% endhint %} | Nome | Descrição | | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `OVERLEAF_SITE_URL` | Onde a sua instância do Overleaf está disponível publicamente. Isto é usado em ligações públicas e quando se liga via websockets, por isso tem de ser configurado corretamente! | | `OVERLEAF_ADMIN_EMAIL` | O endereço de email onde os utilizadores podem contactar a pessoa que gere o site. | | `OVERLEAF_APP_NAME` | O nome a apresentar quando se falar da aplicação em execução. O valor predefinido é 'Overleaf (Community Edition)'. | | `OVERLEAF_MONGO_URL` e `MONGO_URL` | O URL da base de dados Mongo a utilizar. | | `OVERLEAF_REDIS_HOST` e `REDIS_HOST` | O nome do anfitrião da instância Redis a utilizar. Ambos são necessários (ver [notas de versão](broken://pages/a95b370ad11552d06bfbd4a441929f3dcd783c62#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PORT` e `REDIS_PORT` | A porta da instância Redis a utilizar. Ambos são necessários (ver [notas de versão](broken://pages/a95b370ad11552d06bfbd4a441929f3dcd783c62#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PASS` e `REDIS_PASSWORD` | A palavra-passe a utilizar ao ligar ao Redis (se aplicável). **Ambos** as variáveis de ambiente precisam de ser definidas. Ver [ativar a autenticação por palavra-passe](broken://pages/7b9b93b15179e4e5c2f84d9dfc8996b705e682c0) para mais informações. | | `OVERLEAF_REDIS_TLS` |

Se definido como true, permite a ligação a uma instância Redis que exija TLS.

Nota: mTLS não é atualmente suportado.

| | `OVERLEAF_NAV_TITLE` | Define o título do separador da aplicação. | | `OVERLEAF_SESSION_SECRET` | Uma cadeia aleatória usada para proteger tokens; se houver balanceamento de carga, isto precisa de ser definido para o mesmo token em todas as máquinas. Se estiver a ser executada apenas 1 instância, não precisa de ser definido pelo utilizador. | | `OVERLEAF_COOKIE_SESSION_LENGTH` | Permite substituir o tempo predefinido de expiração do cookie de sessão de 5 dias. O valor de substituição deve estar em milissegundos. Exemplo: para fazer a sessão durar 1 hora, defina `COOKIE_SESSION_LENGTH=3600000`. (Adicionado no Server Pro 4.2) | | `OVERLEAF_TRUSTED_PROXY_IPS` |

Se não for definido, o valor predefinido é loopback. Se definir manualmente, para além dos IPs de confiança, também deve incluir um de loopback, localhost ou 127.0.0.1, que confia na instância nginx em execução dentro do sharelatex contentor.

Se estiver a usar uma subnet de 172.16.0.0/12 (subnet predefinida para redes Docker) para a sua rede normal, defina OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\ no seu config/variables.env. Onde \ é o IPAM -> Config -> Subnet valor em docker inspect overleaf\_default, por exemplo OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,172.19.0.0/16. Isto serve para evitar a falsificação de X-Forwarded headers.

Se estiver a usar um proxy TLS externo (ou seja, não gerido pelo Overleaf Toolkit), certifique-se de que OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\, por exemplo OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,192.168.13.37.

| | `OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS` | Se definido como `true`, restringirá os convites para projetos a endereços de email que correspondam a contas de utilizador existentes. | | `OVERLEAF_ALLOW_PUBLIC_ACCESS` | Se definido como `true`, permitirá que utilizadores não autenticados vejam o site. O valor predefinido é `false`, o que significa que os utilizadores não autenticados serão redirecionados incondicionalmente para a página de início de sessão quando tentarem ver qualquer parte do site. Nota: definir esta opção não desativa a autenticação nem a segurança de forma alguma. Esta opção é necessária se os seus utilizadores pretenderem tornar os seus projetos públicos e permitir que utilizadores não autenticados vejam esses projetos. | | `OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING` | Se definido como `true`, permitirá que utilizadores anónimos vejam e editem projetos partilhados através da [partilha por link](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) funcionalidade. | | `OVERLEAF_DISABLE_LINK_SHARING` | Desativa a [partilha por link](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) funcionalidade. | | `EMAIL_CONFIRMATION_DISABLED` | Quando definido como `true` o banner a solicitar confirmação por email não será apresentado. | | `ADDITIONAL_TEXT_EXTENSIONS` | Uma matriz de cadeias para configurar extensões adicionais para ficheiros editáveis. | | `OVERLEAF_STATUS_PAGE_URL` | URL personalizada da página de estado (Adicionado no Server Pro 3.4.0), por exemplo `status.example.com`. | | `OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS` | Defina como `'false'` para impedir que novos projetos sejam inicializados com Full Project History (Adicionado no Server Pro 3.5.0). | | `OVERLEAF_FPH_DISPLAY_NEW_PROJECTS` | Defina como `'false'` para impedir que novos projetos exibam Full Project History em vez do histórico legado (Adicionado no Server Pro 3.5.0). | | `ENABLE_CRON_RESOURCE_DELETION` | Defina esta variável de ambiente como `true` para ativar a limpeza automática de projetos e utilizadores eliminados após 90 dias. | | `OVERLEAF_USER_HARD_DELETION_DELAY` |

Usado para modificar o atraso de expiração dos utilizadores eliminados. Configurado em milissegundos.

Predefinição: 90 dias

| | `OVERLEAF_PROJECT_HARD_DELETION_DELAY` |

Usado para modificar o atraso de expiração dos projetos eliminados. Configurado em milissegundos.

Predefinição: 90 dias

| | `MAX_UPLOAD_SIZE` |

Controla o tamanho máximo de um carregamento individual, em megabytes. O valor predefinido é 50.

Atenção: Esta variável é apenas um número bruto, sem unidade(MB) ou invólucro.

| | `COMPILE_SIZE_LIMIT` | Controla o tamanho máximo do corpo do pedido em bytes. Esta é a soma de todos os tamanhos dos ficheiros de documentos dentro do projeto (`main.tex`, `references.bib` (se não estiver ligado) etc.), que precisa de ser enviada no pedido inicial de compilação para o serviço CLSI. | | `COMPILE_TIMEOUT` | O tempo em segundos permitido para que uma compilação seja concluída. Para mais informações, veja [Atualizar o tempo limite de compilação do projeto](broken://pages/192b5ab451f366c49a4753bf26268b9449920c23#updating-project-compile-timeout). | | `MAX_RECONNECT_GRACEFULLY_INTERVAL_MS` | Um atraso configurável entre a reconexão graciosa do editor, a descarga de dados e o encerramento do contentor para mitigar o risco de perda de dados. | | `SECCOMP_PROFILE` |

Defina esta variável de ambiente para um caminho na máquina anfitriã Docker anfitriã que aponte para o perfil SECCOMP. Pode descarregar uma cópia do perfil aqui.

Atualmente necessário para implementações Podman quando se usam Compilações em Sandbox.

| | `OVERLEAF_DISABLE_CHAT` | Se definido como `true`, desativa a funcionalidade de chat no projeto. | | `OVERLEAF_LOGIN_SUPPORT_TEXT` | Quando definido, pode ser usado para apresentar informações de suporte por baixo do botão de início de sessão. O texto será mostrado no ecrã de início de sessão e pode ser usado para encaminhar os utilizadores para suporte interno ou fornecer orientação relacionada com iniciar sessão, criar contas, etc. | | `ALLOW_MONGO_ADMIN_CHECK_FAILURES` |

Se definido como true, permite que as verificações de arranque do MongoDB falhem e não impeçam o início da implementação. Isto pode ser necessário se usar uma base de dados MongoDB em que o utilizador da base de dados não tenha a função clusterParameterReader role.

Para ajuda na criação de uma função personalizada, veja aqui.

| | `V1_HISTORY_URL_FOR_GIT_BRIDGE` | Permite separar o **history-v1** endpoint para tráfego interno (`web` service → `history-v1` service, ambos no `sharelatex` contentor) e tráfego externo (`git-bridge` → `history-v1`, em contentores separados). | | `OVERLEAF_MAINTENANCE_MESSAGE` e `OVERLEAF_MAINTENANCE_MESSAGE_HTML` | Usado para personalizar o título e o conteúdo da página de Manutenção. Não pode ser usado com `OVERLEAF_STATUS_PAGE_URL`. | {% hint style="info" %} É possível impor restrições de palavra-passe aos utilizadores ao usar o sistema de início de sessão do Overleaf (contas locais), não uma opção SSO como LDAP. Para contas SSO, as políticas de palavra-passe serão aplicadas pelo seu fornecedor de identidade ou serviço de diretório, permitindo adicionalmente suporte para autenticação multifator. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/on-premises/pt/configuracao/overleaf-toolkit/environment-variables.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.