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

# 2. Ознайомлення з Toolkit

### Огляд

Тепер, коли у вас є локальна копія Toolkit, погляньмо на структуру репозиторію за допомогою команди `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> Команда `ls -l` виводить детальний розширений список вмісту каталогу з додатковою інформацією про файли, як-от права доступу, власник і розмір.

Якщо клонування пройшло успішно, ви побачите приблизно таке:

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Усі конфігураційні файли користувача розміщено в каталозі `config/`. Цей каталог **виключено** із системи контролю версій git, тому оновлення Toolkit його не змінюватиме.

## Структура репозиторію

| Назва | Опис |
| - | - |
| `bin` | Ця тека містить набір скриптів, які допомагають керувати вашим екземпляром сервера Overleaf. Докладніше про ці скрипти можна прочитати в розділі «Команди» нижче. |
| `config` | Ця тека містить ваші власні локальні конфігураційні файли. |
| `lib` | Ця тека містить базові конфігураційні файли, які використовує Toolkit. |
| `data` | За замовчуванням ця тека є місцем зберігання даних MongoDb, Redis і Overleaf. Докладніше див. розділ [Постійні дані](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) нижче. |

> [!WARNING]
>
> Ми рекомендуємо **не** змінювати безпосередньо файли поза текою `/config`. Натомість, якщо вам потрібно внести зміни, це можна зробити за допомогою змінних середовища, заданих у **config/variables.env** або **config/overleaf.rc**.\
> Наприклад, щоб задати образ сервісу `mongo`, замість безпосереднього редагування `lib/docker-compose.mongo.yml` задайте образ через змінну середовища `MONGO_IMAGE` у `config/overleaf.rc`. Докладніше див. сторінку [Налаштування Toolkit](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> Toolkit **не** змінюватиме жодних даних у каталозі `config/` без вашого дозволу.

## Команди

Запускайте ці скрипти з каталогу Toolkit. Кожен із них виводить свої параметри з `--help`.

| Команда | Що робить |
| - | - |
| `bin/init` | Уперше створює конфігураційні файли в `config/`. `bin/init --tls` додає конфігурацію TLS-проксі NGINX. |
| `bin/up` | Створює й запускає контейнери (`bin/docker-compose up`). Додайте `-d`, щоб запустити у фоновому режимі замість відстеження журналів. Запускайте її після кожної зміни в `config/`: вона перестворює контейнери, конфігурацію яких змінено. |
| `bin/start` | Знову запускає наявні контейнери (`bin/docker-compose start`). Не застосовує змін конфігурації. |
| `bin/stop` | Зупиняє контейнери, але зберігає їх (`bin/docker-compose stop`). |
| `bin/docker-compose` | Запускає `docker compose` з файлами Toolkit, наприклад `bin/docker-compose ps` або `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Показує або відстежує журнали одного чи кількох сервісів, наприклад `bin/logs -f web`. |
| `bin/error-logs` | Як `bin/logs`, але показує лише помилки. |
| `bin/shell` | Відкриває оболонку всередині контейнера `sharelatex`. |
| `bin/mongo` | Відкриває оболонку MongoDB для бази даних `sharelatex`. |
| `bin/run-script` | Запускає скрипт, що постачається всередині контейнера `sharelatex`. |
| `bin/doctor` | Перевіряє хост і конфігурацію та виводить звіт, яким можна поділитися, коли звертаєтеся по допомогу. |
| `bin/images` | Показує список Docker-образів Overleaf на хості. |
| `bin/backup-config` | Копіює каталог `config/` у місце для резервних копій (копія, zip або tar). |
| `bin/upgrade` | Покроково оновлює Toolkit та образ Overleaf, див. [Оновлення розгортання](https://ayakaleaf-pro.mintlify.site/uk/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Одноразові міграції старих назв змінних `SHARELATEX_*` на `OVERLEAF_*`. |

> [!WARNING]
>
> Коли `bin/up` перестворює контейнер, усе, що було змінено всередині нього, втрачається, наприклад пакети, встановлені через `bin/shell`, або файли, відредаговані через нього. Зберігаються лише каталоги даних (за замовчуванням `data/`) і `config/`. Натомість вносьте постійні зміни через `config/variables.env`, `config/overleaf.rc` або `config/docker-compose.override.yml`.

> [!NOTE]
>
> Якщо кожен `bin/up` виводить усіх користувачів із системи, встановіть `OVERLEAF_SESSION_SECRET`. Без неї cookie сеансів підписуються секретом, який генерується заново щоразу, коли контейнер перестворюється, див. розділ «Питання та відповіді» у [Змінних середовища](https://ayakaleaf-pro.mintlify.site/uk/on-premises/configuration/overleaf-toolkit/environment-variables.md).


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