На этой странице

Развёртывание по HTTPS

Скачайте и проверьте выпуск

Запустите на сервере Docker с Compose 2.24.4 или новее. После публикации стабильного выпуска скачайте contextbase-compose.tar.gz и contextbase-compose.tar.gz.sha256 из одного выпуска на GitHub. В каталоге с этими файлами проверьте и распакуйте архив.

sha256sum -c contextbase-compose.tar.gz.sha256 &&
  mkdir contextbase-release &&
  tar -xzf contextbase-compose.tar.gz -C contextbase-release &&
  cd contextbase-release

На macOS используйте shasum -a 256 -c вместо sha256sum -c.

Создайте администратора до открытия доступа

Запустите ContextBase из распакованного каталога на локальном интерфейсе сервера. Compose скачает готовые образы по закреплённым дайджестам.

export CONTEXTBASE_PLATFORM="$(cat PLATFORM)"
docker compose --project-name contextbase-server \
  -f compose.yaml -f compose.images.yaml \
  up --no-build --pull missing -d --wait

На рабочей станции оператора откройте SSH-туннель и оставьте его запущенным.

ssh -N -L 127.0.0.1:13000:127.0.0.1:13000 user@server

На этой станции откройте http://localhost:13000/setup и создайте администратора. Если вы задали другой порт шлюза, замените оба порта в команде туннеля и порт в адресе браузера.

Включите HTTPS

После создания администратора направьте домен на сервер. Для выпуска сертификата Caddy откройте порты 80 и 443. Если шлюз должен оставаться доступным только внутри сети, настройте доверенный сертификат во входящем в выпуск файле docker/caddy/server-example.Caddyfile. Укажите свой домен в CONTEXTBASE_DOMAIN и выполните команду в том же каталоге. Проверки для выпуска сертификатов Caddy.

export CONTEXTBASE_PLATFORM="$(cat PLATFORM)"
export CONTEXTBASE_DOMAIN=contextbase.example.com
docker compose --project-name contextbase-server \
  -f compose.yaml -f compose.images.yaml -f compose.server.yaml \
  up --no-build --pull missing -d --wait

Откройте https://contextbase.example.com и войдите с уже созданной учётной записью. Для ps, logs и обновлений используйте те же имя проекта, переменные окружения и файлы Compose. Оставьте сервер приложения, базу данных, брокер и хранилище оригиналов в приватных сетях.

Проверьте запуск и адреса браузера

По возможности размещайте веб-интерфейс и API на одном HTTPS-адресе. Caddy направляет запросы к API, админке, проверке состояния, справочнику API, MCP и OAuth в Django, раздаёт статические файлы, а остальные запросы передаёт веб-приложению. Границы заданы в маршрутах шлюза. Исходные файлы доступны через API скачивания с проверкой прав.

Для отдельного хоста веб-интерфейса используйте HTTPS с обеих сторон. Укажите в FRONTEND_ORIGINS полный список адресов (схема, хост и необязательный порт) через запятую и задайте AUTH_REFRESH_COOKIE_SAMESITE=none. Один и тот же список настраивает CORS и доверенные адреса запросов с cookie. В этом режиме cookie требуется флаг Secure. При установке CDN или балансировщика перед Caddy настройте и список доверенных прокси самого Caddy, и TRUSTED_PROXY_COUNT по фактической цепочке.

В производственной конфигурации есть одноразовые шаги migrate и assets. При запуске через Compose проверьте их успешное завершение перед открытием доступа. Если оркестратор игнорирует depends_on, выполните шаги явно один раз для поставки, затем запустите или замените реплики приложения. Схема БД, код, статические файлы и фоновые процессы должны быть совместимы. Шаг assets собирает статические файлы в общий том.

Защитите ключи и данные установки

При установке из выпуска ключи создаются в томе configuration. Делайте его резервную копию вместе с базой данных и оригиналами. Если заменить ключ шифрования отдельно, сохранённые учётные данные провайдеров могут стать нечитаемыми.

Выдавайте ключи API с минимально необходимыми правами и храните учётные данные провайдеров на сервере. Приватные файлы настроек и архивы резервных копий должны оставаться вне системы контроля версий и диагностических пакетов. Подробнее о правах пользователей и приложений — в разделе пространства и доступ. Порядок сообщения об уязвимостях описан в политике безопасности.

Рассчитайте ресурсы и соединения

Чтобы оценить потребность в соединениях, замените up с его параметрами в той же команде Compose на exec web python manage.py connection_budget --processes 8. Вместо 8 укажите число процессов, которые используют эту базу во всех репликах. Учтите веб-воркеры, дочерние процессы воркера Celery и планировщик.

В выпуске по умолчанию используется BGE-M3 на CPU. При первом обращении может потребоваться скачать веса. Том model-cache восстанавливается, но пустой кеш увеличивает время запуска или первого запроса. Планируйте место отдельно для образов, весов, базы данных, оригиналов и временных файлов обработки.

В контрольном прогоне контейнеры Linux/amd64 работали в Docker Desktop с примерно 32 ГиБ памяти, доступными его виртуальной машине. См. условия замера. Перед выбором лимитов измерьте характерные операции и параллельную нагрузку.

Соединения приложения идут через PgBouncer в режиме сессий. В штатной поставке адрес приложения — pgbouncer:6432, а миграции и административные команды идут на основной PostgreSQL, обычно db:5432. При сбое пула автоматического перехода на основной адрес нет. По умолчанию PostgreSQL располагает 100 слотами, бюджет роли платформы в PgBouncer — 64 серверных соединения, а объявленный резерв для прямого доступа — 16. Резерв проверяется при проверке конфигурации. PgBouncer по умолчанию принимает до 512 клиентов. Сравнивайте ожидание клиентов по SHOW POOLS и SHOW STATS с числом подключений в pg_stat_activity.

Базе PostgreSQL нужна кодировка UTF8. Проверьте её на существующей установке перед записью. Параметры инициализации кластера действуют при создании тома. Для изменения кодировки или локали восстановите данные в отдельном совместимом кластере и проверяйте многоязычные тексты, в том числе в полях JSON.

Подключите внешние сервисы

Локальный экстрактор обрабатывает поддерживаемые файлы в UTF-8. Для PDF, офисных документов и OCR подключите отдельный сервис извлечения через EXTRACTOR_BACKEND=http, EXTRACTOR_SERVICE_URL и EXTRACTOR_API_KEY. Проверьте доступность адреса из контейнеров API и воркера. Внутри контейнера localhost указывает на сам контейнер. Форматы описаны в разделе обработка и индексация, а варианты векторных БД — в разделе подключения и хранилища.

Для расчёта эмбеддингов на GPU разверните отдельный OpenAI-совместимый сервис и зарегистрируйте модель в ContextBase. После загрузки весов проверьте доступность сервиса из API и воркера, замерьте память процессов и ускорителя. Выберите модель при создании нового пространства. Для смены модели или представления векторов существующего корпуса запланируйте переиндексацию в новом пространстве. Для генерации используется настроенный сервер LLM со своими лимитами и проверками готовности.

Настройте путь наружу

В пространстве, которым вы владеете, откройте Настройки → Путь наружу, чтобы направить поддерживаемые исходящие соединения через прокси. Например, это относится к вызовам языковой модели. Укажите схему, хост и при необходимости порт, например http://proxy.internal:3128. Поддерживаются схемы http, https, socks5 и socks5h. Для SOCKS нужна поддержка в HTTP-клиенте сервера. Учётные данные прокси введите в отдельные поля. Если при обновлении оставить поле пароля пустым, сохранённый пароль продолжит действовать.

Кнопка Сохранить путь сначала проверяет новую конфигурацию. Если проверка блокирует изменение, действует прежний маршрут. После сохранения форма снова проверяет прокси. Затем проверьте вызов настроенной модели. Кнопка Очистить путь возвращает настройки установки. Прокси установки задают переменные окружения сервера OUTBOUND_PROXY_URL, OUTBOUND_PROXY_USERNAME и OUTBOUND_PROXY_PASSWORD. Свой прокси пространства целиком заменяет этот набор настроек.

ContextBase0.1.0

Поиск в документации