Skip to main content
Yahont CLI включает группу команд deploy, которая устанавливает и обслуживает самостоятельно размещаемое развёртывание Docker Compose: пошаговый установщик и команды жизненного цикла для обновления, проверки, остановки и удаления развёртывания. Это рекомендуемый способ настроить и обслуживать самостоятельно размещаемое развёртывание в Linux, macOS и Windows. Скрипты установки install.sh / install.ps1 — это тонкие обёртки, которые устанавливают CLI и запускают onyx-cli deploy install, поэтому оба пути дают одно и то же развёртывание. Развёртывания, созданные старыми версиями скриптов, обнаруживаются и обслуживаются на месте. По сравнению с ручным управлением файлами Docker Compose CLI:
  • Автоматически синхронизирует файлы compose: deploy upgrade обновляет файлы compose, оверлеи и конфигурацию nginx в соответствии с целевой версией, поэтому вам не нужно самому сравнивать их с репозиторием.
  • Защищает ваши настройки: файлы, изменённые вручную, обнаруживаются по манифесту контрольных сумм и сохраняются в резервной копии, прежде чем их когда-либо перезапишут, а настройки в вашем .env переживают каждое обновление.
  • Помогает в отладке: deploy status показывает расхождение версий и объясняет, почему сервис не работает (перезапуски, код выхода, OOM, последняя неудачная проверка здоровья), а deploy logs сам находит нужные файлы compose и оверлеи.
  • Берёт на себя окружение: проверяет ОЗУ, диск и порты, устанавливает Docker в Linux и генерирует секреты, вместо того чтобы оставлять требования README.
  • Предоставляет удобный и понятный интерфейс: пошаговые запросы с разумными значениями по умолчанию, --help у каждой команды и понятные сообщения об ошибках, а также --no-prompt и --json для автоматизации.

Предварительные требования

Установите CLI из PyPI:
Или с помощью pip:
Другие способы установки см. в обзоре CLI. Шаг onyx-cli configure не нужен — команды deploy работают напрямую с вашим локальным Docker, а не с сервером Yahont.
Прежде чем начать, ознакомьтесь с руководством по ресурсам.

Установка

Интерактивный установщик задаёт два вопроса — режим развёртывания (Lite или Standard) и версию для развёртывания, по умолчанию подставляется последний релиз, — пока в фоне выполняются проверки окружения. Затем он:
  • Проверяет системные ресурсы (ОЗУ, диск) и ищет свободный порт хоста
  • Устанавливает Docker Engine и плагин compose в Linux после подтверждения; запускает Docker Desktop и ждёт его в macOS; обнаруживает Docker и даёт инструкции в Windows
  • Создаёт файл .env из шаблона со случайно сгенерированными секретами
  • Загружает образы Yahont и запускает контейнеры, дожидаясь, пока каждый сервис сообщит, что он работает
Повторный запуск deploy install для существующего развёртывания задаёт один вопрос: Restart (перезапустить как есть) или Upgrade (обновить до новой версии).

Флаги

Например, полностью неинтерактивная установка с закреплённой версией:

Каталог развёртывания

Новые установки находятся в ~/.config/onyx (с учётом XDG). Развёртывания, созданные старыми версиями скрипта install.sh в ./onyx_data, обнаруживаются автоматически и обслуживаются на месте — миграция не нужна. Укажите --dir или задайте переменную окружения ONYX_DEPLOYMENT_DIR, чтобы выбрать конкретное расположение. В каталоге лежат файлы compose, .env и манифест install-state.json, где записаны режим развёртывания, версия и контрольная сумма каждого управляемого файла. Данные приложения там не хранятся — чаты, пользователи и документы находятся в именованных томах Docker.

Офлайн-установка

--offline разворачивает целиком из того, что уже есть на хосте, — без поиска релиза, загрузки конфигурации и загрузки образов. Образы нужно загрузить заранее, а Docker должен быть уже установлен (без сети установщик не может его установить). Флаг подразумевает --local: файлы конфигурации, уже лежащие на диске, используются как есть, а отсутствующие записываются из копий, встроенных в CLI. Всё равно рекомендуется подготовить каталог развёртывания из подключённой к сети установки (ниже): встроенные копии соответствуют версии самого CLI, а не обязательно развёртываемой версии Yahont. На компьютере с доступом в интернет установите последний релиз с теми же флагами режима (или закрепите конкретную версию с помощью --tag), затем экспортируйте образы, которые определило развёртывание:
Скопируйте onyx-images.tar и каталог ~/.config/onyx на офлайн-хост, затем:
Без --tag офлайн-установка предлагает новейшую выпущенную версию, образы которой уже есть на хосте, — только что загруженную. Перед запуском чего-либо установщик проверяет каждый нужный развёртыванию образ и называет каждый отсутствующий — загрузите их с помощью docker load и запустите снова.
deploy upgrade --offline работает так же для перевода изолированного от сети развёртывания на более новую подготовленную версию.

Обновление

Обновляет существующее развёртывание до последнего релиза или до конкретной версии с помощью --tag:
Обновление рассчитано на сохранение ваших настроек:
  • Перезаписывается только строка IMAGE_TAG в .env (а также SANDBOX_BACKEND, когда включён Craft) — все остальные настройки, включая ваши правки, сохраняются.
  • Управляемые файлы (файлы compose, оверлеи, конфигурация nginx) обновляются в соответствии с целевой версией. Файлы, изменённые вами вручную, обнаруживаются по манифесту, сохраняются в резервной копии и перезаписываются только после вашего подтверждения (или с --force).
  • Понижение до более старой версии выдаёт предупреждение и требует подтверждения или --force.
Работающие сервисы продолжают обслуживать запросы, пока загружаются новые образы, а затем пересоздаются на новой версии. upgrade принимает те же флаги --dir, --no-prompt, --local, --offline, --no-wait, --dry-run и --verbose, что и install.

Состояние

Показывает версию, установленную по данным CLI, по .env и по работающим контейнерам (расхождения между ними отмечаются), а также состояние и работоспособность каждого контейнера, опубликованный порт и — для неработающего сервиса — причину (перезапуски, код выхода, OOM, последняя неудачная проверка здоровья). status работает только на чтение и подходит как проверка здоровья: используйте --json для машиночитаемого вывода и проверяйте код завершения.

Журналы

Показывает журналы сервисов без необходимости искать каталог развёртывания или помнить, какие оверлеи compose он использует. Укажите один или несколько сервисов, чтобы сузить вывод, или не указывайте ни одного для всех сервисов.

Остановка

Останавливает контейнеры, не удаляя их и никакие данные. Снова запустите развёртывание с помощью onyx-cli deploy install.

Удаление

Удаляет контейнеры Yahont, тома и каталог развёртывания.
Это безвозвратно удаляет все данные пользователей и документы. В интерактивном режиме для подтверждения нужно ввести DELETE; в неинтерактивном требуется --force.

Перенос существующего развёртывания

Из старого развёртывания install.sh

Сегодняшний install.sh запускает CLI, но старые версии были самостоятельными и устанавливались в каталог onyx_data. Такие развёртывания обслуживаются на месте — запустите CLI из каталога, содержащего onyx_data (или укажите его в --dir), и он возьмёт управление на себя, миграция не требуется. Флаги режимов старого скрипта соответствуют отдельным командам:

Перенос в ~/.config/onyx

Устаревшую установку onyx_data также можно перенести в рекомендуемое расположение ~/.config/onyx. Переносится только конфигурация: чаты, пользователи и документы находятся в именованных томах Docker, привязанных к имени проекта compose (onyx), которое остаётся прежним, поэтому перенесённое развёртывание автоматически подхватывает их. Единственный файл, который обязательно нужно перенести, — .env: в нём секреты, с которыми были инициализированы тома базы данных и объектного хранилища.
Выберите Restart, чтобы запуститься на версии, уже закреплённой в .env, или Upgrade, чтобы перейти на более новую. Файлы compose загружаются заново, поэтому повторно примените свои ручные правки в них. Когда onyx-cli deploy status сообщит, что всё в порядке, удалите старый каталог — в нём только конфигурация:
Удаление старого каталога важно: когда onyx_data существует в рабочем каталоге, CLI предпочитает его, а не ~/.config/onyx. После его удаления обычные команды onyx-cli deploy находят новое расположение без --dir.

Из ручной установки docker compose

Развёртывание, запущенное вручную из каталога deployment/docker_compose репозитория, можно взять под управление так же, если оно использует имя проекта compose по умолчанию (onyx, закреплено в docker-compose.yml):
Установщик обнаруживает скопированный .env как существующее развёртывание, загружает управляемые файлы compose и поднимает стек обратно на существующих томах.
Развёртывания, запущенные под другим именем проекта — старым именем onyx-stack или любым пользовательским значением -p, — хранят свои тома под этим префиксом и не подхватываются автоматически. Продолжайте управлять ими напрямую через docker compose или перенесите данные томов вручную, прежде чем переключаться.

Дальнейшие шаги

Настройте аутентификацию

Настройте аутентификацию для вашего развёртывания Yahont с помощью OAuth, OIDC или SAML.

Больше параметров конфигурации Yahont

Узнайте обо всех доступных параметрах конфигурации вашего развёртывания Yahont.