> For the complete documentation index, see [llms.txt](https://ayakaleaf-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://ayakaleaf-pro.ayaka.space/on-premises/uk/pochatok-roboti/what-is-the-overleaf-toolkit.md). # Що таке Ayakaleaf Toolkit? Набір інструментів ayakaleaf є рекомендованим способом розгортання для локальних інсталяцій Community Edition, Ayakaleaf 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`, набір інструментів надає зручні скрипти для поширених завдань: * `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`: допомагає з оновленням інстансу. Скрипт перевірить наявність оновлень набору інструментів (через 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 не доступно. Distributor ID: Ubuntu Description: Ubuntu 22.04.5 LTS Release: 22.04 Codename: 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 (Бібліотека: 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" %} * Користувачі видання Ayakaleaf Pro можуть створити issue на GitHub: В обох випадках додайте в повідомлення вивід `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://ayakaleaf-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.