> 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/uk/pochatok-roboti/what-is-the-overleaf-toolkit.md). # Що таке Overleaf Toolkit? Набір інструментів Overleaf — рекомендований спосіб розгортання для локальних розгортань Community Edition, Server Pro або Overleaf Pro; він був розроблений для роботи з найпоширенішим середовищем: одним фізичним сервером або віртуальною машиною. Набір інструментів використовує `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** контейнера * `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** контейнера * `bin/upgrade`: допомагає з оновленням екземпляра. Скрипт перевірить оновлення Toolkit (через git) та запропонує підтягнути зміни, перевірить найновішу версію образу Docker і запропонує оновити її. Він надає поетапне підтвердження, можливість створити резервну копію поточної конфігурації та обробляє зупинку/запуск служб Docker. Див. розділ «Оновлення вашого розгортання» для отримання додаткової інформації: {% hint style="info" %} Якщо ви надаєте перевагу запуску свого екземпляра без підключення до журналів Docker, ви можете виконати `bin/up -d` щоб запустити в від'єднаному режимі. {% endhint %} #### Перевірка вашого сервера Набір інструментів Overleaf містить зручний скрипт під назвою `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 - статус: запущено ====== Конфігурація ====== - 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/uk/pochatok-roboti/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.