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

# Отримання допомоги

### Doctor

Overleaf Toolkit постачається зі зручним скриптом `doctor`, що допомагає в налагодженні. Запустіть `bin/doctor`, і скрипт виведе інформацію про ваше хост-середовище, вашу конфігурацію та залежності, потрібні Toolkit. Цей вивід також може допомогти нам діагностувати проблеми з вашими інсталяціями Ayakaleaf Pro.

<Info>
  Користувачі Overleaf Pro можуть [створити issue на GitHub](https://github.com/ayaka-notes/overleaf/issues).

  Варто додати до свого повідомлення вивід скрипта `bin/doctor`.
</Info>

### Консультація з Doctor

Запустіть скрипт doctor:

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

Ви побачите вивід, подібний до наведеного нижче прикладу.

<Accordion title="Приклад повного виводу">
  ```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>

### Інформація про хост

Розділ `Host Information` містить відомості про машину, на якій працює Toolkit (наприклад, дистрибутив і випуск Linux).

<Accordion title="Приклад виводу 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>

### Залежності

Розділ `Dependencies` містить перелік інструментів, необхідних для роботи Toolkit. Якщо інструмент наявний, його буде позначено як `status: present` з інформацією про версію. Якщо він відсутній, його буде позначено як `status: MISSING!`, а внизу виводу `doctor` з'явиться попередження.

<Accordion title="Приклад виводу Dependency (наявний)">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="Приклад виводу Dependency (відсутній)">
  ```text theme={null}
  - docker
      - status: MISSING!
  ```
</Accordion>

Якщо якихось залежностей бракує, Toolkit майже напевно не працюватиме.

### Конфігурація

Розділ `Configuration` містить відомості про файли в каталозі `config/`. Для `config/overleaf.rc` doctor виводить деякі ключові значення. Відсутні файли буде позначено як `status: MISSING!`, а внизу виводу `doctor` з'явиться попередження.

<Accordion title="Приклад виводу 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>

Примітки до наведеного прикладу:

* `OVERLEAF_DATA_PATH`, встановлений у `/tmp/overleaf`, може бути небезпечним розташуванням для важливих даних.
* `MONGO_ENABLED: false` означає, що Toolkit не розгортатиме власну MongoDB; за потреби переконайтеся, що `MONGO_URL` вказує на зовнішньо керовану MongoDB.
* У прикладі відсутній `config/variables.env`.

### Попередження

Розділ `Warnings` підсумовує проблеми, виявлені скриптом doctor. Якщо проблем немає, цей розділ про це повідомить.

<Accordion title="Приклад виводу 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.