> For the complete documentation index, see [llms.txt](https://ayakaleaf-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://ayakaleaf-pro.ayaka.space/on-premises/pt/suporte/getting-help.md).

# Obter ajuda

### O Doctor

O Overleaf Toolkit vem com um prático `doctor` script para ajudar na depuração. Execute `bin/doctor` e o script imprimirá informações sobre o seu ambiente de host, a sua configuração e as dependências que o Toolkit precisa. Esta saída também pode ajudar a equipa de suporte do Overleaf a diagnosticar problemas em instalações do Server Pro.

{% hint style="info" %}
Os utilizadores do Overleaf Pro podem [abrir uma issue no GitHub](https://github.com/ayaka-notes/overleaf/issues).

é uma boa ideia incluir a saída do `bin/doctor` script na sua mensagem.
{% endhint %}

### Consultando o Doctor <a href="#consulting-with-the-doctor" id="consulting-with-the-doctor"></a>

Execute o script doctor:

{% code title="Executar doctor" %}

```bash
bin/doctor
```

{% endcode %}

Verá uma saída semelhante ao exemplo abaixo.

<details>

<summary>Exemplo de saída completa</summary>

```
====== Overleaf Doctor ======
- Informações do anfitrião
    - Linux
    - Saída de 'lsb_release -a':
            Não há módulos LSB disponíveis.
            ID da distribuição:	Ubuntu
            Descrição:	Ubuntu 22.04.5 LTS
            Versão:	22.04
            Nome de código:	jammy
- Dependências
    - bash
        - estado: presente
        - informação da versão: 5.1.16(1)-release
    - docker
        - estado: presente
        - info. de versão: Docker version 28.0.4, build b8034c0
    - docker compose
        - estado: presente
        - info. de versão: Docker Compose version v2.34.0
    - realpath
        - estado: presente
        - informação da versão: realpath (GNU coreutils) 8.32
    - perl
        - estado: presente
        - informação da versão: 5.034000
    - awk
        - estado: presente
        - info. de versão: mawk 1.3.4 20200120
- Docker Daemon
    - estado: em execução
====== Configuração ======
- config/version
    - estado: presente
    - versão: 5.4.0
- config/overleaf.rc
    - estado: presente
    - valores
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
        - SIBLING_CONTAINERS_ENABLED: true
            - ligado ao quay.io: true
        - MONGO_ENABLED: true
        - REDIS_ENABLED: true
- config/variables.env
    - estado: presente
    - valores
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs

====== Avisos ======
- Nenhum, tudo bem
====== Fim ======
```

</details>

### Informações do host

O `Informações do host` a secção contém informações sobre a máquina que está a executar o Toolkit (por exemplo, a distribuição e a versão do Linux).

<details>

<summary>Exemplo de saída das Informações do host</summary>

```
- Informações do anfitrião
    - Linux
    - Saída de 'lsb_release -a':
            Não há módulos LSB disponíveis.
            ID da distribuição:	Ubuntu
            Descrição:	Ubuntu 22.04.5 LTS
            Versão:	22.04
            Nome de código:	jammy
```

</details>

### Dependências

O `Dependências` a secção lista as ferramentas necessárias para o Toolkit funcionar. Se uma ferramenta estiver presente, será listada como `estado: presente` com informação de versão. Se estiver em falta, será listada como `estado: EM FALTA!` e um aviso será adicionado ao final da `doctor` saída.

<details>

<summary>Exemplo de saída das Dependências (presente)</summary>

```
- docker
    - estado: presente
    - info. de versão: Docker version 28.0.4, build b8034c0
```

</details>

<details>

<summary>Exemplo de saída das Dependências (em falta)</summary>

```
- docker
    - estado: EM FALTA!
```

</details>

Se alguma dependência estiver em falta, o Toolkit muito provavelmente não funcionará.

### Configuração

O `Configuração` a secção contém informações sobre ficheiros no `config/` diretório. Para `config/overleaf.rc`, o doctor imprime alguns valores-chave. Os ficheiros em falta serão listados como `estado: EM FALTA!` e um aviso será adicionado ao final da `doctor` saída.

<details>

<summary>Exemplo de saída da Configuração</summary>

```
====== Configuração ======
- config/version
    - estado: presente
    - versão: 5.4.0
- config/overleaf.rc
    - estado: presente
    - valores
        - OVERLEAF_DATA_PATH: /tmp/overleaf
        - SERVER_PRO: false
        - MONGO_ENABLED: false
        - REDIS_ENABLED: true
- config/variables.env
    - estado: EM FALTA!
```

</details>

Notas do exemplo acima:

* `OVERLEAF_DATA_PATH` definido para `/tmp/overleaf` pode não ser uma localização segura para dados importantes.
* `MONGO_ENABLED: false` significa que o Toolkit não provisionará o seu próprio MongoDB; certifique-se de que `MONGO_URL` aponta para um MongoDB gerido externamente, se necessário.
* `config/variables.env` está em falta no exemplo.

### Avisos

O `Avisos` a secção resume os problemas encontrados pelo script doctor. Se não houver problemas, esta secção indicará isso.

<details>

<summary>Exemplo de saída de Avisos</summary>

```
====== Avisos ======
- ficheiro de configuração variables.env não encontrado
- ficheiro rc, OVERLEAF_DATA_PATH não definido
====== Fim =======
```

</details>


---

# 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://ayakaleaf-pro.ayaka.space/on-premises/pt/suporte/getting-help.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.
