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

# Что такое Ayakaleaf Toolkit?

Ayakaleaf Toolkit — рекомендуемый способ локального развёртывания Community Edition и Ayakaleaf Pro. Он рассчитан на наиболее распространённую среду: один физический сервер или виртуальную машину. Toolkit использует `docker compose` для управления Docker-контейнерами сервера и предоставляет набор скриптов-обёрток над командами `docker`, которые помогают с технической стороной управления локальной версией Overleaf.

#### Обёртка `bin/docker-compose`

Скрипт `bin/docker-compose` — это обёртка над `docker compose`. Он загружает конфигурацию из каталога `config/`, а затем вызывает `docker compose` с аргументами, переданными скрипту.

`bin/docker-compose` можно рассматривать как прозрачную обёртку над программой `docker compose`, установленной на вашей машине.

Пример:

```bash title="Check running containers" theme={null}
$ bin/docker-compose ps
```

#### Вспомогательные скрипты

Помимо `bin/docker-compose`, Toolkit предоставляет удобные скрипты для решения типовых задач:

* `bin/up`: сокращение для `bin/docker-compose up`
* `bin/start`: сокращение для `bin/docker-compose start`
* `bin/stop`: сокращение для `bin/docker-compose stop`
* `bin/shell`: запускает оболочку внутри контейнера **sharelatex**
* `bin/doctor`: скрипт для сбора информации об установке и развёртывании. См. раздел «Проверка сервера» ниже
* `bin/mongo`: запускает оболочку внутри контейнера **mongo** и переключается на нужную базу данных (**sharelatex**)
* `bin/backup-config`: создаёт копию (zip или tar) текущей конфигурации и сохраняет её в выбранный вами каталог
* `bin/logs`: просмотр/отслеживание логов сервисов
* `bin/error-logs`: просмотр/отслеживание логов ошибок сервисов
* `bin/rename-env-vars-5-0`: скрипт миграции для обновления переменных окружения в **config/variables.env** (ребрендинг с ShareLaTeX на Overleaf)
* `bin/rename-rc-vars`: скрипт миграции для обновления переменных окружения в **config/overleaf.rc** (ребрендинг с ShareLaTeX на Overleaf)
* `bin/run-script`: вспомогательный скрипт, упрощающий запуск скриптов, хранящихся в контейнере **sharelatex**
* `bin/upgrade`: помогает обновлять экземпляр. Скрипт проверяет наличие обновлений Toolkit (через git) и предлагает загрузить изменения, проверяет последнюю версию Docker-образа и предлагает обновить её. Он запрашивает подтверждение на каждом шаге, предлагает создать резервную копию текущей конфигурации и берёт на себя остановку и запуск сервисов Docker. Подробнее см. «Обновление развёртывания»: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Если вы предпочитаете запускать экземпляр без подключения к логам Docker, выполните `bin/up -d`, чтобы запустить его в фоновом режиме.
</Info>

#### Проверка сервера

Overleaf Toolkit включает удобный скрипт `bin/doctor`, который формирует отчёт с указанием всех неудовлетворённых зависимостей.

Прежде чем продолжить, запустите скрипт `bin/doctor` и убедитесь, что всё работает правильно:

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

Пример вывода (сокращённый/иллюстративный):

<Accordion title="Пример вывода bin/doctor">
  ```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 27.3.1, build ce12230
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
      - openssl
          - status: present
          - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
      - docker compose
          - status: present
          - version info: Docker Compose version v2.29.7
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.1.1
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
              - logged in to quay.io: true
          - SIBLING_CONTAINERS_ENABLED: true
          - OVERLEAF_LISTEN_IP: 0.0.0.0
          - OVERLEAF_PORT: 80
          - MONGO_ENABLED: true
          - MONGO_IMAGE: mongo
          - MONGO_VERSION: 6.0
          - MONGO_DATA_PATH: data/mongo
          - REDIS_ENABLED: true
          - REDIS_IMAGE: redis:6.2
          - REDIS_DATA_PATH: data/redis
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs
  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

Если какие-либо зависимости отсутствуют, doctor выведет предупреждения. При возникновении проблем сначала запустите `bin/doctor` и проверьте его вывод на наличие предупреждений.

<Info>
  * Пользователи Ayakaleaf Pro Edition могут создать issue на GitHub: [https://github.com/ayaka-notes/toolkit/issues](https://github.com/ayaka-notes/toolkit/issues)

  В обоих случаях приложите к сообщению вывод `bin/doctor`.
</Info>


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