> 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/instalacao/using-the-toolkit/5.-personalizing-your-instance.md).

# 5. Personalizar a sua instância

### A personalizar a sua instância <a href="#personalizing-your-instance" id="personalizing-your-instance"></a>

Antes de iniciar a sua instância Overleaf pela primeira vez, atualize o `config/variables.env` ficheiro de configuração com as suas informações personalizadas.

{% stepper %}
{% step %}

### Edite o ficheiro de variáveis

Abrir `config/variables.env` no seu editor de texto preferido e atualize as variáveis de ambiente abaixo com os valores necessários.
{% endstep %}

{% step %}

### Variáveis de ambiente obrigatórias

Atualize as seguintes variáveis em `config/variables.env`:

| Nome                          | Descrição                                                                                                                                                                   | Exemplo                         |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| `OVERLEAF_SITE_URL`           | Onde a sua instância do Overleaf está disponível publicamente. Isto é usado em ligações públicas e ao ligar via websockets, por isso **deve ser configurado corretamente**! | `https://overleaf.lilliput.com` |
| `OVERLEAF_EMAIL_FROM_ADDRESS` | Este endereço de email será usado como o `de` endereço para todos os emails enviados.                                                                                       | `no-reply@lilliput.com`         |
| `OVERLEAF_ADMIN_EMAIL`        | O endereço de email onde os utilizadores podem contactar a pessoa que gere o site.                                                                                          | `it-services@lilliput.com`      |

Depois de atualizar estas variáveis de ambiente, guarde e feche.
{% endstep %}

{% step %}

### Iniciar a sua instância

Para iniciar a sua instância, execute:

{% code title="Iniciar a instância" %}

```
bin/up
```

{% endcode %}

Este comando irá transferir as imagens necessárias, criar os contentores (usando as suas personalizações) e iniciar a instância. Deverá ver a saída dos registos dos vários contentores Docker.

Para os iniciar novamente mais tarde (sem anexar à saída dos registos), execute:

{% code title="Iniciar sem anexar aos registos" %}

```
bin/start
```

{% endcode %}
{% endstep %}
{% endstepper %}

{% hint style="info" %}
O Toolkit usa `docker compose` para gerir os contentores Docker do Overleaf. O Toolkit fornece um conjunto de scripts que encapsulam `docker compose` e tratam da maioria dos detalhes por si.
{% endhint %}

Se tudo correr bem, deverá conseguir ver a página de início de sessão da sua nova instância Overleaf ao navegar para <http://127.0.0.1/> ou <http://localhost/> no seu navegador.

{% hint style="warning" %}
Dependendo da configuração da sua rede e de onde a sua instância Overleaf está alojada, poderá ser necessário fazer alterações adicionais de configuração. Consulte as definições do Toolkit para mais detalhes:

<https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/toolkit-settings>
{% 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/instalacao/using-the-toolkit/5.-personalizing-your-instance.md?ask=<question>&goal=<endgoal>
```

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