2. Знакомство с Toolkit

​

Осмотримся

Теперь, когда у вас есть локальная копия Toolkit, давайте посмотрим на структуру репозитория с помощью команды ls.

Run this

ls -l

Команда ls -l выводит подробный (длинный) список содержимого каталога с дополнительной информацией о файлах, такой как права доступа, владелец и размер.

Если клонирование прошло успешно, вы увидите примерно следующее:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

Все пользовательские файлы конфигурации находятся в каталоге config/. Этот каталог исключён из системы контроля версий git, поэтому он не будет изменён при обновлении Toolkit.

​

Структура репозитория

Имя	Описание
bin	Эта папка содержит набор скриптов, помогающих управлять вашим экземпляром сервера Overleaf. Подробнее об этих скриптах можно прочитать в разделе «Команды» ниже.
config	Эта папка содержит ваши собственные локальные файлы конфигурации.
lib	Эта папка содержит базовые файлы конфигурации, используемые Toolkit.
data	По умолчанию в этой папке находится хранилище данных MongoDb, Redis и Overleaf. Подробнее см. раздел Постоянные данные ниже.

Мы рекомендуем не изменять напрямую файлы за пределами папки /config. Если вам нужно внести изменения, это можно сделать с помощью переменных окружения, заданных в config/variables.env или config/overleaf.rc.
Например, чтобы задать образ сервиса mongo, не редактируйте lib/docker-compose.mongo.yml напрямую, а укажите образ с помощью переменной окружения MONGO_IMAGE в config/overleaf.rc. Подробнее см. страницу Параметры Toolkit.

Toolkit не изменяет никакие данные в каталоге config/ без вашего разрешения.

​

Команды

Запускайте эти скрипты из каталога Toolkit. Каждый из них выводит свои параметры с флагом --help.

Команда	Что делает
bin/init	Создаёт конфигурационные файлы в config/ при первом запуске. bin/init --tls добавляет конфигурацию TLS-прокси NGINX.
bin/up	Создаёт и запускает контейнеры (bin/docker-compose up). Добавьте -d, чтобы запустить в фоновом режиме, не отслеживая логи. Запускайте после каждого изменения в config/: команда пересоздаёт контейнеры, конфигурация которых изменилась.
bin/start	Снова запускает существующие контейнеры (bin/docker-compose start). Не применяет изменения конфигурации.
bin/stop	Останавливает контейнеры, сохраняя их (bin/docker-compose stop).
bin/docker-compose	Запускает docker compose с файлами Toolkit, например bin/docker-compose ps или bin/docker-compose restart sharelatex.
bin/logs	Показывает или отслеживает логи одного или нескольких сервисов, например bin/logs -f web.
bin/error-logs	Как bin/logs, но показывает только ошибки.
bin/shell	Открывает оболочку внутри контейнера sharelatex.
bin/mongo	Открывает оболочку MongoDB для базы данных sharelatex.
bin/run-script	Запускает скрипт, поставляемый внутри контейнера sharelatex.
bin/doctor	Проверяет хост и конфигурацию и выводит отчёт, которым можно поделиться при обращении за помощью.
bin/images	Выводит список Docker-образов Overleaf на хосте.
bin/backup-config	Копирует каталог config/ в место для резервных копий (копия, zip или tar).
bin/upgrade	Пошагово обновляет Toolkit и образ Overleaf, см. Обновление развёртывания.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Разовые миграции старых имён переменных SHARELATEX_* в OVERLEAF_*.

Когда bin/up пересоздаёт контейнер, все изменения внутри него теряются, например пакеты, установленные через bin/shell, или отредактированные там файлы. Сохраняются только каталоги данных (по умолчанию data/) и config/. Вносите постоянные изменения через config/variables.env, config/overleaf.rc или config/docker-compose.override.yml.

Если каждый bin/up приводит к выходу всех пользователей из системы, задайте OVERLEAF_SESSION_SECRET. Без неё сессионные cookie подписываются секретом, который генерируется заново при каждом пересоздании контейнера, см. раздел «Вопросы и ответы» в Переменные окружения.