Saltar para o conteúdo principal

Personalizando sua instância

Antes de iniciar sua instância do Overleaf pela primeira vez, atualize dois arquivos de configuração com suas informações personalizadas:
1

Edite o arquivo de variáveis

Abra config/variables.env no seu editor de texto favorito e atualize as variáveis de ambiente abaixo com os valores necessários.
2

Endereço e porta de escuta

Por padrão, o Toolkit publica a interface web em 127.0.0.1:80, de modo que ela só pode ser aberta a partir de um navegador no próprio servidor. Outros computadores recebem um erro de “conexão recusada” ou “servidor não encontrado”. Para mudar isso, edite config/overleaf.rc:
config/overleaf.rc
OVERLEAF_LISTEN_IP é o endereço IP do host ao qual o contêiner faz bind, e OVERLEAF_PORT é a porta do host. Juntos, eles formam o mapeamento de portas do Docker OVERLEAF_LISTEN_IP:OVERLEAF_PORT:80. Escolha os valores que correspondem à sua configuração:Se a porta 80 já estiver em uso no host, por exemplo por outro servidor web, defina OVERLEAF_PORT como uma porta livre, como 8080. Caso contrário, o bin/up falha com bind: address already in use.
As portas publicadas pelo Docker ignoram firewalls do host, como ufw e firewalld. Com 0.0.0.0, a instância fica acessível a partir de todas as redes às quais o servidor está conectado. Em um servidor na nuvem, você também precisa liberar a porta no grupo de segurança do provedor. Use HTTPS antes de expor a instância à internet; consulte Proxy TLS.
Você pode começar com o padrão e abrir a instância primeiro em localhost. Para permitir o acesso a partir de outros computadores mais tarde, altere essas duas variáveis em config/overleaf.rc e OVERLEAF_SITE_URL em config/variables.env e, em seguida, execute bin/up novamente para recriar os contêineres.
3

Variáveis de ambiente obrigatórias

Atualize as seguintes variáveis em config/variables.env:OVERLEAF_SITE_URL é o endereço que os usuários digitam no navegador, não o endereço de escuta. Inclua a porta quando ela não for 80 (HTTP) ou 443 (HTTPS), por exemplo http://192.168.1.20:8080. Não use http://0.0.0.0. Se OVERLEAF_SITE_URL não corresponder ao endereço no navegador, o editor não consegue se conectar, e os links em e-mails e os callbacks de OAuth apontam para o lugar errado.Sem um servidor de e-mail, deixe OVERLEAF_EMAIL_FROM_ADDRESS sem definir: assim o Overleaf não envia e-mails, e você mesmo pode fornecer aos novos usuários o link de ativação; consulte as Q&A em Acesso público.Defina também OVERLEAF_SESSION_SECRET com um valor gerado por openssl rand -hex 32. Sem ela, todo bin/up que recria o contêiner, e toda atualização, desconecta todos os usuários. Consulte as Q&A em Variáveis de ambiente.Depois de atualizar essas variáveis de ambiente, salve e saia.
4

Configure o Sandbox Compile

Em seguida, configure o TeX Live Full para sandboxed-compiles.md. Abra config/variables.env e atualize as seguintes variáveis de ambiente:
config/variables.env
5

Inicie sua instância

Para iniciar sua instância, execute:
Start the instance
Este comando baixará as imagens necessárias, incluindo o texlive, criará os contêineres (usando suas personalizações) e iniciará a instância. Você deverá ver a saída de log dos vários contêineres Docker.Para iniciá-los novamente mais tarde (sem se conectar à saída de log), execute:
Start without attaching to logs
O Toolkit usa o docker compose para gerenciar os contêineres Docker do Overleaf. O Toolkit fornece um conjunto de scripts que encapsulam o docker compose e cuidam da maioria dos detalhes para você.
Se tudo correr bem, você deverá conseguir ver a página de login da sua nova instância do Overleaf acessando http://127.0.0.1/ ou http://localhost/ no seu navegador. Se você alterou OVERLEAF_LISTEN_IP ou OVERLEAF_PORT, abra o endereço da tabela na etapa Endereço e porta de escuta, por exemplo http://<server-ip>:8080. Para verificar em qual endereço e porta a interface web está publicada, execute:
Show the published port
A saída, por exemplo 0.0.0.0:8080, mostra o endereço IP e a porta do host em uso. Se mostrar 127.0.0.1, a instância só é acessível a partir do próprio servidor.
Dependendo da sua configuração de rede e de onde sua instância do Overleaf está hospedada, talvez seja necessário fazer alterações adicionais de configuração. Consulte as configurações do Toolkit para mais detalhes: toolkit-settings.md
Última modificação em 8 de novembro de 2026