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

# Obtendo ajuda

### O Doctor

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

<Info>
  Os usuários do Overleaf Pro podem [abrir uma issue no GitHub](https://github.com/ayaka-notes/overleaf/issues).

  É uma boa ideia incluir a saída do script `bin/doctor` na sua mensagem.
</Info>

### Consultando o Doctor

Execute o script doctor:

```bash title="Run doctor" theme={null}
bin/doctor
```

Você verá uma saída semelhante ao exemplo abaixo.

<Accordion title="Exemplo de saída completa">
  ```text theme={null}
  ====== Overleaf Doctor ======
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  - Dependencies
      - bash
          - status: present
          - version info: 5.1.16(1)-release
      - docker
          - status: present
          - version info: Docker version 28.0.4, build b8034c0
      - docker compose
          - status: present
          - version info: Docker Compose version v2.34.0
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: mawk 1.3.4 20200120
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
          - SIBLING_CONTAINERS_ENABLED: true
              - logged in to quay.io: true
          - MONGO_ENABLED: true
          - REDIS_ENABLED: true
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs

  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

### Informações do host

A seção `Host Information` contém informações sobre a máquina que executa o Toolkit (por exemplo, a distribuição e a versão do Linux).

<Accordion title="Exemplo de saída de Host Information">
  ```text theme={null}
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  ```
</Accordion>

### Dependências

A seção `Dependencies` lista as ferramentas necessárias para o funcionamento do Toolkit. Se uma ferramenta estiver presente, ela será listada como `status: present` com informações de versão. Se estiver ausente, será listada como `status: MISSING!` e um aviso será adicionado ao final da saída do `doctor`.

<Accordion title="Exemplo de saída de dependência (presente)">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="Exemplo de saída de dependência (ausente)">
  ```text theme={null}
  - docker
      - status: MISSING!
  ```
</Accordion>

Se alguma dependência estiver ausente, o Toolkit quase certamente não funcionará.

### Configuração

A seção `Configuration` contém informações sobre os arquivos no diretório `config/`. Para `config/overleaf.rc`, o doctor exibe alguns valores importantes. Arquivos ausentes serão listados como `status: MISSING!` e um aviso será adicionado ao final da saída do `doctor`.

<Accordion title="Exemplo de saída de Configuration">
  ```text theme={null}
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: /tmp/overleaf
          - SERVER_PRO: false
          - MONGO_ENABLED: false
          - REDIS_ENABLED: true
  - config/variables.env
      - status: MISSING!
  ```
</Accordion>

Observações sobre o exemplo acima:

* `OVERLEAF_DATA_PATH` definido como `/tmp/overleaf` pode não ser um local seguro para dados importantes.
* `MONGO_ENABLED: false` significa que o Toolkit não provisionará seu próprio MongoDB; certifique-se de que `MONGO_URL` aponte para um MongoDB gerenciado externamente, se necessário.
* `config/variables.env` está ausente no exemplo.

### Avisos

A seção `Warnings` resume os problemas descobertos pelo script doctor. Se não houver problemas, esta seção indicará isso.

<Accordion title="Exemplo de saída de Warnings">
  ```text theme={null}
  ====== Warnings ======
  - configuration file variables.env not found
  - rc file, OVERLEAF_DATA_PATH not set
  ====== End =======
  ```
</Accordion>


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