> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/ru/nachalo-raboty/what-is-the-overleaf-toolkit.md). # Что такое Overleaf Toolkit? Overleaf Toolkit — рекомендуемый способ развёртывания для локальных установок Community Edition, Server Pro или Overleaf Pro; он был разработан для работы с наиболее распространённой средой: одним физическим сервером или виртуальной машиной. Toolkit использует `docker compose` для управления Docker-контейнерами вашего сервера и предоставляет набор скриптов, которые оборачивают `docker` команды, чтобы помочь с более технической стороной управления локальной версией Overleaf. #### Скрипт `bin/docker-compose` обёртка Скрипт `bin/docker-compose` скрипт является обёрткой вокруг `docker compose`. Он загружает конфигурацию из каталога `config/` перед вызовом `docker compose` с любыми аргументами, переданными скрипту. Вы можете рассматривать `bin/docker-compose` как прозрачную обёртку для `docker compose` программы, установленной на вашей машине. Пример: {% code title="Проверка запущенных контейнеров" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Удобные помощники Помимо `bin/docker-compose`, Toolkit предоставляет удобные скрипты для помощи с распространёнными задачами: * `bin/up`: ярлык для `bin/docker-compose up` * `bin/start`: ярлык для `bin/docker-compose start` * `bin/stop`: ярлык для `bin/docker-compose stop` * `bin/shell`: запускает оболочку внутри контейнера **sharelatex** container * `bin/doctor`: скрипт, используемый для сбора информации об установке и развёртывании. См. раздел «Проверка вашего сервера» ниже * `bin/mongo`: запускает оболочку внутри контейнера **mongo** контейнер и переключается на правильную базу данных (**sharelatex**) * `bin/backup-config`: создаёт копию (zip или tar) вашей текущей конфигурации и сохраняет её в выбранном вами каталоге назначения * `bin/logs`: просмотр/хвост логов службы * `bin/error-logs`: просмотр/хвост логов ошибок службы * `bin/rename-env-vars-5-0`: скрипт миграции для обновления переменных окружения в **config/variables.env** (ребрендинг с ShareLaTeX на Overleaf) * `bin/rename-rc-vars`: скрипт миграции для обновления переменных окружения в **config/overleaf.rc** (ребрендинг с ShareLaTeX на Overleaf) * `bin/run-script`: помощник, упрощающий запуск скриптов, хранящихся внутри **sharelatex** container * `bin/upgrade`: помогает с обновлением экземпляра. Скрипт проверит наличие обновлений Toolkit (через git) и предложит загрузить изменения, проверит последнюю версию образа Docker и предложит обновить его. Он предоставляет пошаговое подтверждение, возможность создать резервную копию текущей конфигурации и управляет остановкой/запуском служб Docker. См. раздел «Обновление вашего развёртывания» для получения дополнительной информации: {% hint style="info" %} Если вы предпочитаете запускать свой экземпляр, не подключаясь к логам Docker, вы можете выполнить `bin/up -d` для запуска в отсоединённом режиме. {% endhint %} #### Проверка вашего сервера Overleaf Toolkit включает удобный скрипт под названием `bin/doctor` который формирует отчёт, указывающий на любую невыполненную зависимость. Прежде чем продолжить, запустите `bin/doctor` скрипт и проверьте, что всё работает правильно: {% code title="Запустить Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Пример вывода (сокращённый/иллюстративный):
Пример вывода bin/doctor ``` ====== Overleaf Doctor ====== - Сведения о хосте - Linux - Вывод 'lsb_release -a': Модули LSB недоступны. Идентификатор дистрибутива: Ubuntu Описание: Ubuntu 22.04.5 LTS Релиз: 22.04 Кодовое имя: jammy - Зависимости - bash - статус: присутствует - сведения о версии: 5.1.16(1)-release - docker - статус: присутствует - сведения о версии: Docker version 27.3.1, build ce12230 - realpath - статус: присутствует - сведения о версии: realpath (GNU coreutils) 8.32 - perl - статус: присутствует - сведения о версии: 5.034000 - awk - статус: присутствует - сведения о версии: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - статус: присутствует - сведения о версии: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - статус: присутствует - сведения о версии: Docker Compose version v2.29.7 - Docker Daemon - статус: запущен ====== Конфигурация ====== - config/version - статус: присутствует - версия: 5.1.1 - config/overleaf.rc - статус: присутствует - значения - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - вход в quay.io выполнен: true - SIBLING_CONTAINERS_ENABLED: true - OVERLEAF_LISTEN_IP: 0.0.0.0 - OVERLEAF_PORT: 80 - MONGO_ENABLED: true - MONGO_IMAGE: mongo - MONGO_VERSION: 6.0 - MONGO_DATA_PATH: data/mongo - REDIS_ENABLED: true - REDIS_IMAGE: redis:6.2 - REDIS_DATA_PATH: data/redis - config/variables.env - статус: присутствует - значения - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Предупреждения ====== - Нет, всё в порядке ====== Конец ====== ```
Если какие-либо зависимости отсутствуют, doctor выведет предупреждения. Если у вас возникнут проблемы, сначала запустите `bin/doctor` и проверьте его вывод на наличие предупреждений. {% hint style="info" %} * Пользователям бесплатной Community Edition следует открыть issue на GitHub: * Пользователям Server Pro следует обратиться в поддержку: mailto: В обоих случаях приложите вывод `bin/doctor` в своём сообщении. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/on-premises/ru/nachalo-raboty/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.