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

# Налаштування Toolkit

На цій сторінці описано змінні середовища, які підтримуються у файлі `config/overleaf.rc` для розгортань через Toolkit.

Файл `config/overleaf.rc` складається з визначень змінних у форматі `NAME=value`. Рядки, що починаються з `#`, вважаються коментарями.

<Info>
  Після будь-яких змін у `overleaf.rc` або `variables.env` необхідно перестворити контейнери Docker, виконавши `bin/up`.
</Info>

## Контейнер

### `sharelatex`

| Назва | Опис |
| - | - |
| `PROJECT_NAME` | <p>Задає значення прапорця `--project-name`, що передається до `docker-compose`. Це корисно, якщо на одному хості працює кілька екземплярів Overleaf, оскільки кожен екземпляр може мати власну назву проєкту.<br /><br />- <strong>За замовчуванням</strong>: `overleaf`</p> |
| `OVERLEAF_IMAGE_NAME` | <p>Образ Docker, який використовує контейнер застосунку Server Pro/CE. Це лише назва образу Docker; тег образу Docker береться з `config/version`.<br /><br />- <strong>За замовчуванням:</strong><br />- Server Pro: `ghcr.io/ayaka-notes/overleaf-pro`<br />- Community Edition: `sharelatex/sharelatex`</p> |
| `SERVER_PRO` | <p>Якщо встановлено `true`, Toolkit використовує образ Server Pro (`ghcr.io/ayaka-notes/overleaf-pro`) замість стандартного образу Server CE (`sharelatex/sharelatex`).<br /><br />- <strong>За замовчуванням</strong>: `false`</p> |
| `GIT_BRIDGE_ENABLED` | <p>Встановіть `true`, щоб увімкнути функцію git-bridge (лише Server Pro). Докладніше див. документацію для користувачів <a href="https://www.overleaf.com/learn/how-to/Git_integration">[https://www.overleaf.com/learn/how-to/Git\_integration](https://www.overleaf.com/learn/how-to/Git_integration)</a>.<br /><br />- <strong>За замовчуванням:</strong> `false`</p> |
| `GIT_BRIDGE_IMAGE` | <p>Образ Docker, який використовує контейнер git-bridge (лише Server Pro). Це лише назва образу Docker; тег образу Docker береться з `config/version`.<br /><br />- <strong>За замовчуванням:</strong> `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`</p> |
| `GIT_BRIDGE_DATA_PATH` | Задає шлях до каталогу, який буде змонтовано в контейнер `git-bridge` (лише Server Pro) і використано для зберігання git-репозиторіїв. Це може бути повний шлях (що починається з `/`) або шлях відносно базового каталогу Toolkit. |
| `GIT_BRIDGE_LOG_LEVEL` | <p>Налаштовує рівень журналювання контейнера `git-bridge`. Доступні рівні: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.<br /><br />- <strong>За замовчуванням:</strong> `INFO`</p> |
| `SIBLING_CONTAINERS_ENABLED` | <p>Якщо встановлено `true`, Toolkit використовує техніку <strong>Sibling Containers</strong> для компіляції проєктів в окремих пісочницях, з окремим контейнером Docker для кожного проєкту. Докладніше див. документацію \<server-pro-only-configuration/sandboxed-compiles>.<br /><br />- <strong>Потребує:</strong> `SERVER_PRO=true`<br />- <strong>За замовчуванням:</strong> `true`</p> |
| `SIBLING_CONTAINERS_PULL` | <p>Якщо встановлено `true`, Toolkit під час виконання команди `bin/up` автоматично завантажує всі образи TeX Live, задані через `ALL_TEX_LIVE_DOCKER_IMAGES` у файлі <strong>config/variables.env</strong>.<br /><br />- <strong>За замовчуванням:</strong> `true`</p> |
| `DOCKER_SOCKET_PATH` | <p>Задає шлях до сокета Docker на хост-машині (машині, на якій працює Toolkit). Якщо `SIBLING_CONTAINERS_ENABLED` дорівнює `true`, сокет буде змонтовано в контейнер, щоб служба компілятора могла запускати нові контейнери Docker на хості.<br /><br />- <strong>Потребує:</strong> `SIBLING_CONTAINERS_ENABLED=true`<br />- <strong>За замовчуванням:</strong> `/var/run/docker.sock`</p> |
| `OVERLEAF_DATA_PATH` | <p>Задає шлях до каталогу, який буде змонтовано в основний контейнер `sharelatex` і використано для зберігання даних компіляції. Це може бути повний шлях (що починається з `/`) або шлях відносно базового каталогу Toolkit.<br /><br />- <strong>За замовчуванням:</strong> `data/overleaf`</p> |
| `OVERLEAF_LISTEN_IP` | <p>Задає IP-адресу (адреси) хоста, до якої прив'язується контейнер. Наприклад, якщо встановлено `0.0.0.0`, вебінтерфейс буде доступний за будь-якою IP-адресою хоста. Для прямого доступу до контейнера значення `OVERLEAF_LISTEN_IP` має бути вашою публічною IP-адресою. Встановлення `OVERLEAF_LISTEN_IP` у `0.0.0.0` або зовнішню IP-адресу хоста зазвичай спричиняє помилки під час використання разом із .<br /><br />- <strong>За замовчуванням:</strong> `127.0.0.1`</p> |
| `OVERLEAF_PORT` | <p>Задає порт хоста, до якого прив'язується контейнер. Наприклад, якщо встановлено `8099`, а `OVERLEAF_LISTEN_IP` — `127.0.0.1`, вебінтерфейс буде доступний за адресою `http://localhost:8099`.<br /><br />- <strong>За замовчуванням:</strong> `80`</p> |
| `OVERLEAF_LOG_PATH` | <p>Задає шлях до каталогу, який буде змонтовано в основний контейнер `sharelatex` і використано для того, щоб журнали застосунку були доступні на хості Docker. Це може бути повний шлях (що починається з `/`) або шлях відносно базового каталогу Toolkit. Видаліть цей запис конфігурації, щоб вимкнути bind-mount. Якщо значення не задано, журнали буде втрачено під час перестворення контейнера.<br /><br />Відомості про журналювання див. у .<br /><br />- <strong>За замовчуванням:</strong> не задано</p> |

***

### `mongo`

| Назва | Опис |
| - | - |
| `MONGO_ENABLED` | <p>Якщо встановлено `true`, Toolkit створює контейнер MongoDB для розміщення бази даних. Якщо встановлено `false`, цей контейнер не створюється, а система натомість використовує базу даних MongoDB, задану через `MONGO_URL`.<br /><br />- <strong>За замовчуванням</strong>: `true`</p> |
| `MONGO_URL` | <p>Задає URL-адресу підключення до MongoDB, яка використовується, коли `MONGO_ENABLED` дорівнює `false`.<br /><br />- <strong>За замовчуванням</strong>: не задано</p> |
| `MONGO_DATA_PATH` | <p>Задає шлях до каталогу, який буде змонтовано в контейнер `mongo` і використано для зберігання бази даних MongoDB. Це може бути повний шлях (що починається з `/`) або шлях відносно базового каталогу toolkit. Цей параметр впливає лише на локальний контейнер `mongo`, який створюється, коли `MONGO_ENABLED` дорівнює `true`.<br /><br />- <strong>За замовчуванням</strong>: `data/mongo`</p> |
| `MONGO_IMAGE` | <p>Образ Docker, який використовує контейнер MongoDB. Це лише назва образу Docker; тег образу Docker слід вказувати в `MONGO_VERSION` (див. нижче).<br /><br />- <strong>За замовчуванням:</strong> `mongo`</p> |
| `MONGO_VERSION` | <p>Версія MongoDB, яку використовує контейнер MongoDB. Значення має починатися з основної версії MongoDB і крапки, наприклад `6.0` або `6.0-with-suffix`.<br /><br />- <strong>За замовчуванням:</strong> `6.0`</p> |

***

### `redis`

| Назва | Опис |
| - | - |
| `REDIS_ENABLED` | <p>Якщо встановлено `true`, Toolkit створює контейнер Redis для розміщення бази даних redis. Якщо встановлено `false`, цей контейнер не створюється, а система натомість використовує базу даних Redis, задану через `REDIS_HOST` і `REDIS_PORT`.<br /><br />- <strong>За замовчуванням</strong>: `true`</p> |
| `REDIS_HOST` | <p>Задає хост Redis, який використовується, коли `REDIS_ENABLED` дорівнює `false`.<br /><br />- <strong>За замовчуванням</strong>: не задано</p> |
| `REDIS_PORT` | <p>Задає порт Redis, який використовується, коли `REDIS_ENABLED` дорівнює `false`.<br /><br />- <strong>За замовчуванням</strong>: не задано</p> |
| `REDIS_DATA_PATH` | <p>Задає шлях до каталогу, який буде змонтовано в контейнер `redis` і використано для зберігання бази даних Redis. Це може бути повний шлях (що починається з `/`) або шлях відносно базового каталогу Toolkit. Цей параметр впливає лише на локальний контейнер `redis`, який створюється, коли `REDIS_ENABLED` дорівнює `true`.<br /><br />- <strong>За замовчуванням</strong>: `data/redis`</p> |
| `REDIS_AOF_PERSISTENCE` | <p>Вмикає збереження AOF (Append Only File) для Redis. Це <strong>рекомендована</strong> конфігурація збереження даних Redis.<br /><br />Додаткові відомості див. у розділі \<../../../maintenance/data-and-backups#aof-append-only-file> на сторінці \<../../maintenance/data-and-backups>.<br /><br />- <strong>За замовчуванням:</strong> `true`</p> |

***

### `nginx`

| Назва | Опис |
| - | - |
| `NGINX_ENABLED` | <p>Якщо встановлено `true`, Toolkit створює контейнер NGINX, який працює як TLS-проксі.<br /><br />- <strong>За замовчуванням</strong>: `false`</p> |
| `NGINX_CONFIG_PATH` | <p>Шлях до файлу конфігурації NGINX для TLS-проксі.<br /><br />- <strong>За замовчуванням</strong>: `config/nginx/nginx.conf`</p> |
| `NGINX_TLS_LISTEN_IP` | <p>Задає IP-адресу (адреси) хоста, до якої прив'язується контейнер TLS-проксі для HTTPS. Наприклад, якщо встановлено `0.0.0.0`, вебінтерфейс HTTPS буде доступний за будь-якою IP-адресою хоста. Зазвичай тут слід вказати зовнішню IP-адресу хоста.<br /><br />- <strong>За замовчуванням</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_LISTEN_IP` | <p>Задає IP-адресу (адреси) хоста, до якої прив'язується контейнер TLS-проксі для HTTP-переспрямування. Наприклад, якщо встановлено `127.0.1.1`, HTTP-з'єднання з `127.0.1.1` переспрямовуватимуться на вебінтерфейс HTTPS. Зазвичай тут слід вказати зовнішню IP-адресу хоста. Не встановлюйте `0.0.0.0`, оскільки це зазвичай спричиняє конфлікт з `OVERLEAF_LISTEN_IP`.<br /><br />- <strong>За замовчуванням</strong>: `127.0.1.1`</p> |
| `NGINX_HTTP_PORT` | <p>Задає порт хоста, до якого прив'язується контейнер TLS-проксі для HTTP.<br /><br />- <strong>За замовчуванням</strong>: `80`</p> |
| `TLS_PORT` | <p>Задає порт хоста, до якого прив'язується контейнер TLS-проксі для HTTPS.<br /><br />- <strong>За замовчуванням</strong>: `443`</p> |
| `TLS_PRIVATE_KEY_PATH` | <p>Шлях до приватного ключа для TLS-проксі.<br /><br />- <strong>За замовчуванням</strong>: `config/nginx/certs/overleaf_key.pem`</p> |
| `TLS_CERTIFICATE_PATH` | <p>Шлях до публічного сертифіката для TLS-проксі.<br /><br />- <strong>За замовчуванням</strong>: `config/nginx/certs/overleaf_certificate.pem`</p> |


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