Настройки 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-монтирование. Если не задано, журналы будут удалены при пересоздании контейнера. Информацию о журналировании см. в . - По умолчанию: не задано

`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 г.