Налаштування Toolkit - Ayakaleaf Pro

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

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

Контейнер

`sharelatex`

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

`mongo`

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

`redis`

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

`nginx`

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

Останнє оновлення 5 жовтня 2026 р.