> ## 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. Докладніше див. Upgrading your deployment: [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`, щоб запустити його у фоновому режимі (detached mode).
</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.