Skip to main content
Прежде чем начать работу с Docker, ознакомьтесь с руководством по ресурсам.
В этом руководстве описан ручной запуск Docker Compose. Чтобы установить Yahont одной командой, используйте установщик. Yahont CE работает только в Docker Compose.

Руководство

1

Установите необходимое

2

Клонируйте репозиторий Yahont CE

3

Перейдите к файлам compose

4

Создайте файл .env

Без значения USER_AUTH_SECRET сервер API не запустится. Для рабочей установки смените в .env также пароли по умолчанию (PostgreSQL, S3, OpenSearch). Подсказки есть в самом файле.
5

Запустите Yahont

В Windows вместо ручного запуска используйте установщик или WSL2.
docker compose up -d скачивает готовые образы yahontai/yahont-ce-backend, yahontai/yahont-ce-web и yahontai/yahont-ce-model-server из Docker Hub. Версию задаёт IMAGE_TAG в .env: по умолчанию latest. Чтобы закрепить выпуск, укажите его тег вида vX.Y.Z. Образы опубликованы для платформы linux/amd64. Для ARM готовых образов нет.Чтобы собрать образы из исходного кода вашей копии репозитория (свои правки, ARM), запускайте docker compose up -d --build. Сборка веб-образа требует около 4 ГБ оперативной памяти.Обновление: git pull, затем docker compose pull и docker compose up -d. Если вы собирали образы сами, docker compose pull заменит их опубликованными, а docker compose up -d --build вернёт ваши.
После запуска контейнеров системе нужно пройти процесс инициализации. Затем Yahont будет доступен по адресу localhost:3000. Если вы запустили Yahont на удалённом сервере, откройте http://<адрес сервера>:3000: localhost — это компьютер, на котором работают контейнеры. Первый зарегистрированный пользователь становится администратором. Имя проекта Docker Compose — yahont, поэтому контейнеры называются yahont-<сервис>-1.

Режим «Лайт»

Режим «Лайт» запускает 5 контейнеров и использует около 1 ГБ памяти в покое. Стандартный режим использует около 7,3 ГБ. В режиме «Лайт» нет коннекторов, поиска по документам и знаний агентов. Подробное сравнение режимов — в разделе Обзор развёртывания. Установщик запускает этот режим параметром --lite (-Lite). Вручную выполните из каталога deployment/docker_compose:
Пустое значение COMPOSE_PROFILES= в начале команды отключает объектное хранилище из env.template: в режиме «Лайт» файлы и сессии хранит PostgreSQL.
Режимы хранят файлы и сессии в разных местах. Чтобы перейти из одного режима в другой, запустите второй под другим именем проекта (docker compose -p yahont-lite ...): файлы, загруженные в одном режиме, в другом не видны.
Подробнее о режиме «Лайт» и его переменных — в конфигурации.

Обновление

Выполните из каталога deployment/docker_compose:
Если вы собираете образы сами, используйте git pull && docker compose up -d --build.

Логи, состояние и остановка

Выполните из каталога deployment/docker_compose:
В стандартном режиме работают сервисы api_server, background, web_server, inference_model_server, indexing_model_server, relational_db, opensearch, nginx и cache. Команда docker compose down останавливает и удаляет контейнеры. Данные хранятся в томах Docker и остаются. Команда docker compose down -v удаляет и тома, то есть все ваши данные.

Привязка порта к 127.0.0.1

По умолчанию Docker Compose публикует порты 80 и 3000 на всех сетевых интерфейсах. Если вы запускаете Yahont на сервере с публичным адресом, не оставляйте их открытыми. Чтобы приложение слушало только локальный адрес, создайте рядом с docker-compose.yml файл docker-compose.override.yml (нужен Docker Compose 2.24.4 или новее):
Укажите в .env адрес сайта в WEB_DOMAIN и перенаправляйте на этот порт прокси.
Брандмауэр ufw не закрывает порты, которые публикует Docker.

Публикация за HTTPS

В Docker Compose из репозитория нет сертификатов и HTTPS. Поставьте перед Yahont обратный прокси. Пошаговая инструкция с Nginx и Let’s Encrypt — на странице Yahont за обратным прокси с HTTPS.

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

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

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

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

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