> ## 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-монтирование. Если не задано, журналы будут удалены при пересоздании контейнера.<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.