К содержимому

Конфигурация Space ​

Space читает окружение процесса и TOML-файл доступа и исполнения при старте. Сам бинарник не загружает .env. В примере запуска его читает Compose. После изменения настроек перезапустите соответствующие процессы.

Сервис и БД ​

ПеременнаяПо умолчаниюНазначение
DATABASE_URLОбязательнаDSN отдельной PostgreSQL БД Space. Одинаковый у API, worker и миграций
ORPHEUS_CONFIG_FILEorpheus-space.tomlПуть к TOML доступа и исполнения у API и worker
ORPHEUS_MIGRATIONS_DIRmigrationsКаталог миграций из образа
ORPHEUS_HOST, ORPHEUS_PORT0.0.0.0, 8000Адрес публичного API
ORPHEUS_SYSTEM_HOST, ORPHEUS_SYSTEM_PORT0.0.0.0, 9100Системный адрес каждого процесса
WORKER_POLL_SECONDS1Положительный интервал опроса worker в секундах, допускает дробные значения
MAX_REQUEST_BYTES1048576Максимум тела запроса, от 4096 до 1048576 байт

Все сервисы каталога Orpheus доступны пользователю с правом редактирования задания. Значения секретов передаются worker Orpheus. Space хранит только выбранные коды сервисов.

Подключение Orpheus ​

ПеременнаяНазначение
ORPHEUS_BASE_URLHTTP(S)-origin Orpheus, доступный из Space, без /api/v1
ORPHEUS_API_KEYBearer-ключ Orpheus для запуска, опроса статусов и чтения результатов

Обе переменные обязательны у worker. API использует их для каталогов профилей, шаблонов и сервисов, создания задания, проверки выбора и получения результата. Если Orpheus недоступен, эти операции возвращают 503. Сохранение прежнего выбора сервисов и очистка всего списка не требуют этого каталога. Выдайте Space отдельный ключ из PUBLIC_API_KEYS Orpheus. Он отличается от ключа, которым CLI обращается к Space.

Доступ к Space ​

ПеременнаяПо умолчаниюНазначение
PUBLIC_API_KEYS[]JSON-массив Bearer-ключей Space. Непустой в режиме api_only
ORPHEUS_BROWSER_AUTHapi_onlyapi_only, anonymous или saml
ORPHEUS_PUBLIC_URLНетТочный внешний origin браузера без завершающего слеша. Обязателен в anonymous и saml, в SAML только HTTPS

API использует ORPHEUS_PUBLIC_URL также для поля url задания — ссылки на его карточку в Space Web. Если адрес не задан, url равен null. Ссылка вычисляется при ответе, поэтому изменение адреса не требует редактирования заданий. Адрес запроса и заголовки прокси для неё не используются.

Поле TOML access.admin_emails содержит email администраторов SAML:

toml
[access]
admin_emails = ["admin@example.com"]

По умолчанию []: администраторов SAML нет. Пробелы по краям удаляются, регистр приводится к нижнему. Неверные адреса и дубликаты после нормализации запрещают запуск. После изменения списка перезапустите API. Действующие сессии получают новую роль на следующем запросе. API-ключи и режим anonymous сохраняют полный доступ.

Права, Origin и CSRF. Worker проверяет название режима, но не использует браузерные настройки и SAML-файлы.

SAML на API ​

ПеременнаяНазначение
SAML_SP_ENTITY_IDEntity ID отдельного клиента Space
SAML_IDP_METADATA_FILEПуть к XML метаданных IdP
SAML_SP_CERT_FILEПуть к сертификату SP
SAML_SP_KEY_FILEПуть к приватному ключу SP
BROWSER_SESSION_TTL_SECONDSСрок браузерной сессии. По умолчанию 43200 секунд, диапазон 300–86400

Первые четыре настройки обязательны в режиме saml. Файлы считываются при старте API. Инструкция по SSO.

Базовое исполнение TOML ​

toml
[execution.agent]
profile = "default"
instructions_file = "/etc/orpheus-space/instructions.md"

[execution.sandbox]
template = "codex"

[execution.limits]
run_timeout_seconds = 3600
max_session_tokens = 1000000
ПолеНазначение
execution.agent.profileОбязательный профиль Orpheus по умолчанию для новых заданий
execution.agent.instructionsНеобязательные инструкции строкой. Пустая строка очищает инструкции профиля
execution.agent.instructions_fileАльтернатива строке: UTF-8 файл инструкций, смонтированный в API и worker
execution.sandbox.templateОбязательный шаблон AgentBox по умолчанию для новых заданий
execution.limits.run_timeout_secondsПоложительный таймаут запуска. По умолчанию 3600 секунд
execution.limits.max_session_tokensНеобязательный положительный лимит токенов сессии

instructions и instructions_file взаимоисключающие. Если оба отсутствуют, сохраняются инструкции профиля Orpheus. Space принимает только перечисленные поля TOML.

Изменение эффективной базовой конфигурации начинает новый контекст при следующем исполнении задания с повторным использованием сессии.

Выбор сервисов ​

  1. Опишите сервис в каталоге Orpheus.
  2. Передайте значения его ENV worker Orpheus.
  3. Выберите код в поле services задания.

В конфигурации Space нет сервисов по умолчанию или списков ENV. Пропущенный выбор при создании равен []. Пустой список удаляет все выбранные сервисы. Неизвестный код возвращает 422. Недоступный каталог возвращает 503, когда требуется проверка выбора. Прежний выбор и очистку сервисов можно сохранить без каталога. Возобновление задания с паузы проверяет весь выбор.

Корневой каталог сервисов возвращает {items: [...]}. Каталоги профилей и шаблонов возвращают страницы с items, next_cursor и prev_cursor. Настройки заданий содержат browser_auth, default_profile и default_template. Проверяйте значения по умолчанию по точному name без фильтра активности или доступности: запись может отсутствовать или быть неактивной.

Создание, редактирование и возобновление задания проверяют итоговый шаблон, даже если поле не изменяется. Только PATCH ровно с {"status":"paused"} пропускает эту проверку. Пауза и удаление работают без Orpheus. Неизвестный или неактивный шаблон возвращает 422 с деталью по пути body.template.

Веб-интерфейс ​

ORPHEUS_SPACE_UPSTREAM в образе Space Web задаёт внутренний origin API Space, например http://space-api:8000. По нему nginx проксирует API и маршруты авторизации. Публичный браузерный origin задаётся на API через ORPHEUS_PUBLIC_URL.

CLI ​

ПеременнаяНазначение
ORPHEUS_SPACE_HOSTПубличный origin Space без /api/v1
ORPHEUS_SPACE_API_KEYКлюч из PUBLIC_API_KEYS Space

Флаг --host заменяет только адрес. Ключ принимается только из окружения. Установка и команды.