> ## 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="Пример вывода зависимости (установлена)">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="Пример вывода зависимости (отсутствует)">
  ```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.