Постоянные данные
Overleaf Toolkit необходимо хранить постоянные данные, например файлы, нужные для компиляции проектов LaTeX, и содержимое базы данных MongoDB. Для этого несколько каталогов хост-машины монтируются в Docker-контейнеры, и данные записываются в эти каталоги.Каталоги данных
Контейнеруsharelatex нужен каталог для хранения данных, связанных с компиляцией LaTeX. Этот каталог задаётся переменной OVERLEAF_DATA_PATH в config/overleaf.rc.
Контейнеру mongo, если он включён, нужен каталог для хранения файлов базы данных; то же относится и к контейнеру redis. Эти каталоги также можно настроить в config/overleaf.rc.
Права доступа к файлам
Поскольку Docker работает от имениroot, каталоги данных в итоге будут принадлежать пользователю root, даже если Toolkit используется не-root-пользователем. Это не проблема, но об этом стоит помнить, если вы собираетесь изменять постоянные данные вне контейнеров.
Расположение конфигурационных файлов
Все конфигурационные файлы, принадлежащие пользователю, находятся в каталогеconfig/.
Этот каталог исключён из системы контроля версий git, поэтому обновление кода Toolkit его не затронет. Toolkit не изменяет данные в каталоге config/ без вашего разрешения.
Изменения в конфигурационных файлах не применяются автоматически к существующим контейнерам, даже если контейнер остановить и снова запустить (с помощью
bin/stop и bin/start). Чтобы применить изменения, выполните bin/up — в фоновом режиме docker compose автоматически применит изменения конфигурации к новому контейнеру. (Или выполните bin/up -d, если не хотите подключаться к логам Docker.)Файл config/overleaf.rc
Файл config/overleaf.rc содержит самые важные параметры конфигурации верхнего уровня, используемые Toolkit. В нём находятся инструкции, задающие переменные, в формате: VARIABLE_NAME=value
Подробное описание всех доступных параметров конфигурации см. в нашем разделе о настройках.
Файл variables.env
Файл config/variables.env содержит переменные окружения, которые загружаются в контейнер sharelatex и используются для настройки микросервисов Overleaf. Среди них — название приложения, отображаемое в заголовке веб-интерфейса, параметры отправки электронной почты и другие настройки, например SSO.
Подробное описание всех доступных переменных окружения см. в разделе Переменные окружения.
Файл config/version
Файл config/version содержит номер версии Docker-образа, который будет использоваться для создания работающего экземпляра вашего сервера Overleaf.
Изменения в этих конфигурационных файлах не применяются автоматически к существующим контейнерам, даже если контейнер остановить и снова запустить (с помощью
bin/stop и bin/start). Чтобы применить изменения, выполните bin/up, и Toolkit автоматически создаст для вас новый контейнер с применёнными изменениями конфигурации.Файл docker-compose.override.yml
Если файл config/docker-compose.override.yml существует, он будет включён в вызов docker compose. Это полезно для переопределения настроек, специфичных для Docker Compose.
config/variables.env не загружается в контейнеры mongo и redis. Чтобы задать в них переменную окружения, добавьте её здесь и выполните bin/up -d, например:
Вопросы и ответы
Какую файловую систему следует использовать для каталогов данных? Можно ли использовать btrfs, копирование при записи или сжатие zstd?
Какую файловую систему следует использовать для каталогов данных? Можно ли использовать btrfs, копирование при записи или сжатие zstd?
Ответ: Toolkit не проверяет файловую систему. Требования к ней предъявляет MongoDB, поэтому выбор важнее всего для
data/mongo (MONGO_DATA_PATH). В рекомендациях для продакшена MongoDB говорится, что в Linux следует использовать XFS или ext4, и настоятельно рекомендуется XFS с WiredTiger — используемым ею движком хранения. Btrfs и другие файловые системы с копированием при записи там не рассматриваются. Если ваша корневая файловая система — btrfs, можно смонтировать том XFS и указать его в MONGO_DATA_PATH. Файловая система также должна поддерживать fsync() для каталогов, чего не поддерживают HGFS и общие папки VirtualBox.Сжатие на уровне файловой системы мало что даёт для data/mongo: WiredTiger уже сжимает коллекции с помощью snappy, а индексы — с помощью префиксного сжатия. Об NFS см. Устранение неполадок.
