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

# 5. Personalizando sua instância

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

| Arquivo | Lido por | Definido aqui |
| - | - | - |
| `config/overleaf.rc` | os scripts do Toolkit, como `bin/up` | como os contêineres são executados: `OVERLEAF_LISTEN_IP`, `OVERLEAF_PORT`, `SERVER_PRO`, caminhos de dados |
| `config/variables.env` | a aplicação dentro do contêiner | como o Overleaf se comporta: `OVERLEAF_SITE_URL`, e-mail, imagens do TeX Live |

**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`:

```bash title="config/overleaf.rc" theme={null}
OVERLEAF_LISTEN_IP=0.0.0.0
OVERLEAF_PORT=8080
```

`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:

| Configuração | `OVERLEAF_LISTEN_IP` | `OVERLEAF_PORT` | Abrir no navegador |
| - | - | - | - |
| Apenas nesta máquina (padrão) | `127.0.0.1` | `80` | `http://localhost` |
| Outros computadores na LAN ou na internet se conectam diretamente | `0.0.0.0`, ou um IP do servidor | `80`, ou qualquer porta livre | `http://<server-ip>:<port>` |
| Atrás do seu próprio proxy reverso (NGINX, Caddy, Cloudflare Tunnel) no mesmo host | `127.0.0.1` | qualquer porta livre | a URL do proxy |
| Atrás do [proxy TLS](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/tls-proxy.md) do Toolkit | `127.0.0.1` | `80` | `https://<your-domain>` |

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

> [!WARNING]
>
> 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](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/tls-proxy.md).

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`:

| Nome | Descrição | Exemplo |
| - | - | - |
| `OVERLEAF_SITE_URL` | Onde sua instância do Overleaf está disponível publicamente. Isso é usado em links públicos e ao conectar via websockets, portanto **deve ser configurado corretamente**! | `https://overleaf.lilliput.com` |
| `OVERLEAF_EMAIL_FROM_ADDRESS` | Este endereço de e-mail será usado como endereço `from` em todos os e-mails enviados. | `no-reply@lilliput.com` |
| `OVERLEAF_ADMIN_EMAIL` | O endereço de e-mail pelo qual os usuários podem entrar em contato com o responsável pelo site. | `it-services@lilliput.com` |

`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](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/authentication/public-access.md).

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](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/environment-variables.md).

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](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/sandboxed-compiles.md "mention"). Abra `config/variables.env` e atualize as seguintes variáveis de ambiente:

```dotenv title="config/variables.env" wrap theme={null}
ALL_TEX_LIVE_DOCKER_IMAGES=ghcr.io/ayaka-notes/texlive-full:2026.1, ghcr.io/ayaka-notes/texlive-full:2025.1
ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=Texlive 2026, Texlive 2025
TEX_LIVE_DOCKER_IMAGE=ghcr.io/ayaka-notes/texlive-full:2026.1
```

**5. Inicie sua instância**

Para iniciar sua instância, execute:

```text title="Start the instance" theme={null}
bin/up
```

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:

```text title="Start without attaching to logs" theme={null}
bin/start
```

> [!NOTE]
>
> 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/](http://127.0.0.1/) ou [http://localhost/](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:

```text title="Show the published port" theme={null}
bin/docker-compose port sharelatex 80
```

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.

> [!WARNING]
>
> 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](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/toolkit-settings.md "mention")


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