> 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/2.-familiarize-yourself-with-the-toolkit.md).

# 2. Familiarize-se com o Toolkit

### Dando uma vista de olhos ao redor <a href="#taking-a-look-around" id="taking-a-look-around"></a>

Agora que tem uma cópia local do Toolkit, vamos analisar a estrutura do repositório usando o `ls` comando.

{% code title="Execute isto" %}

```bash
ls -l
```

{% endcode %}

{% hint style="info" %}
O `ls -l` o comando apresenta uma listagem longa e detalhada do conteúdo de um diretório, fornecendo informações adicionais sobre os ficheiros, como permissões, propriedade e tamanho.
{% endhint %}

Se tudo tiver sido clonado com êxito, deverá ver algo assim:

```
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

{% hint style="info" %}
Todos os ficheiros de configuração pertencentes ao utilizador encontram-se na `config/` pasta. Esta pasta é **excluída** do sistema de controlo de revisões do git, pelo que não será alterada ao atualizar o Toolkit.
{% endhint %}

## Estrutura do repositório

| Nome     | Descrição                                                                                                                                                                                                                                                                  |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bin`    | Esta pasta contém uma coleção de scripts que ajudam a gerir a sua instância do servidor Overleaf. Pode ler mais sobre estes scripts na nossa secção Comandos abaixo.                                                                                                       |
| `config` | Esta pasta contém os seus próprios ficheiros de configuração locais.                                                                                                                                                                                                       |
| `lib`    | Esta pasta contém os ficheiros de configuração base usados pelo Toolkit.                                                                                                                                                                                                   |
| `data`   | Por predefinição, esta pasta contém o local de armazenamento para MongoDb, Redis e Overleaf. Para mais informações, consulte [Dados persistentes](https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/files-and-locations#persistent-data) secção abaixo. |

{% hint style="warning" %}
Recomendamos **não** alterar ficheiros fora da `/config` pasta diretamente. Em vez disso, se precisar de fazer alterações, estas podem ser feitas através de variáveis de ambiente definidas em qualquer um dos **config/variables.env** ou **config/overleaf.rc**.\
Por exemplo, para definir a `mongo` imagem do serviço, em vez de editar `lib/docker-compose.mongo.yml` diretamente, defina a imagem usando a variável de ambiente `MONGO_IMAGE` em `config/overleaf.rc`. Para mais informações, consulte a [Definições do Toolkit](broken://pages/f0535d702a75d75dbcd6419824f6add02da1918d) página.
{% endhint %}

{% hint style="info" %}
O Toolkit irá **não** alterar quaisquer dados na `config/` pasta sem a sua permissão.
{% 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/2.-familiarize-yourself-with-the-toolkit.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.