Быстрый старт

Voxagent поставляется бандлом — docker-compose.yml и эталонный .env.example — прямо с этого сайта документации. Образы лежат в приватном container registry registry.nodul.ru — доступ выдаётся по read-only токену (см. ниже).

1. Скачать бандл

mkdir Voxagent && cd Voxagent
curl -O https://docs.voxagent.app/cdn/docker-compose.yml
curl -O https://docs.voxagent.app/cdn/.env.example

• docker-compose.yml — полный стек сервисов (включает одноразовый сервис postgres-init, который создаёт дополнительные БД/пользователей после того как Postgres становится healthy)
• .env.example — эталонные переменные окружения

2. Запросить токен для реестра

Образы из registry.nodul.ru/voxagent/nodevoice/* требуют read-only токен. Токены выдаются каждому клиенту по запросу — напишите нам на help@mail.voxagent.app, и мы пришлём токен.

После этого залогиньтесь на хосте — docker сам спросит логин и пароль:

docker login registry.nodul.ru/voxagent/nodevoice

3. Настроить

cp .env.example .env

Базовый .env.example уже содержит всё необходимое для локального запуска — можно оставить как есть и поднимать стек. Ключи LLM/STT/TTS-провайдеров, SMTP для Keycloak, биллинг, телефония и прочие интеграции — опциональны и нужны только для соответствующего функционала.

Полный референс переменных — в Конфигурации.

4. Запустить стек

Сначала подтяните актуальные образы — чтобы не работать с устаревшим :latest, закешированным при прошлом docker login:

docker compose pull
docker compose up -d

Первый запуск занимает несколько минут — Postgres инициализируется, Keycloak импортирует realm, Lago накатывает миграции и сидит биллинг-организацию.

5. Дождаться angular-client

Проверить статус сервисов:

docker compose ps -a --format "table {{.Service}}\t{{.Status}}\t{{.Ports}}"

Как только строка angular-client покажет Up ... (healthy) — приложение готово, открывайте http://localhost:4210.

6. Создать пользователя

На странице входа нажмите Регистрация и создайте учётную запись.

В поставке для docker compose подтверждение email по умолчанию отключено (KEYCLOAK_VERIFY_EMAIL=false), регистрация моментальная.

Включить подтверждение email

Если хотите, чтобы пользователи подтверждали почту перед первым входом, в .env:

1. Включите флаг:

   KEYCLOAK_VERIFY_EMAIL=true

2. Заполните SMTP-реквизиты Keycloak (с них уходят письма верификации и сброса пароля):

   KEYCLOAK_SMTP_HOST=smtp.example.com
   KEYCLOAK_SMTP_PORT=465
   KEYCLOAK_SMTP_FROM=no-reply@example.com
   KEYCLOAK_SMTP_USER=<smtp-логин>
   KEYCLOAK_SMTP_PASSWORD=<smtp-пароль>
   KEYCLOAK_SMTP_SSL=true       # 465
   KEYCLOAK_SMTP_STARTTLS=false # переключите на true для порта 587

3. Перезапустите Keycloak, чтобы применить:

   docker compose up -d --force-recreate keycloak

Другие точки входа

Когда стек полностью поднялся:

Порты настраиваются в .env в секции HOST PORTS — меняйте любой, если на вашей машине он уже занят.

Что дальше

• Требования — подобрать хост под ожидаемую нагрузку.
• Конфигурация — полный референс переменных.
• Установка — другие варианты развёртывания (managed, Kubernetes).