Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/omnigent-ai/omnigent/llms.txt

Use this file to discover all available pages before exploring further.

Environment variables configure the server daemon, CLI behavior, and runtime sandboxing. Variables prefixed OMNIGENT_ are Omnigent-specific; model credentials use provider-native names recognized by the underlying harness SDKs. Most variables have sensible defaults for local development — only deployments that need auth, a remote database, or cloud sandboxes need to set them.
The CLI stores model credentials in the OS keychain via omnigent setup. Environment variables are a convenient override for CI/automated environments where the keychain is not available.

Server

Variables that control server daemon behavior. Set these when running omnigent server or in docker-compose.yaml.
VariableDefaultDescription
PORT / OMNIGENT_PORT6767TCP port the server listens on. OMNIGENT_PORT is used by Docker Compose; PORT by some platform environments.
OMNIGENT_AUTH_ENABLED0 (local), 1 (Docker)Master auth switch. 1 enables accounts or OIDC auth. 0 uses header mode with a single "local" user.
OMNIGENT_AUTH_PROVIDER(auto-detected)Explicit auth mode override: accounts, oidc, or header. When not set, the mode is auto-detected from OMNIGENT_OIDC_ISSUER (sets OIDC) or falls back to accounts.
OMNIGENT_LOCAL_SINGLE_USER(auto-set)Set to 1 automatically for loopback-bound servers in header mode; prevents 401s on headerless local traffic. Typically not set manually.
DATABASE_URLsqlite:///<data-dir>/chat.dbSQLAlchemy database URL. Supports sqlite:/// and postgresql:///postgres://.
OMNIGENT_DATABASE_URI(same as DATABASE_URL)Alternative name for the database URI recognized by the daemon’s environment allowlist.
OMNIGENT_CONFIG_HOME~/.omnigentOverride the user-level config home directory. Tests and CI use this to isolate per-invocation config from the developer’s real ~/.omnigent. Not typically needed in production.
OMNIGENT_DATA_DIR~/.omnigentOverride the per-user state directory (config, pidfiles, logs, session state). Used internally for test isolation and git-worktree scenarios; not typically set manually in production.
OMNIGENT_CONFIG<data_dir>/config.yamlPath to the server’s YAML config file (admins, allowed_domains, policy_modules, artifact_location, etc.).
OMNIGENT_SERVER_SHUTDOWN_TIMEOUT_S30Seconds Uvicorn waits for active WebSocket / SSE connections to drain after SIGTERM before force-closing them.
OMNIGENT_RUNNER_TUNNEL_TOKENPre-shared token that binds a specific runner’s tunnel at server startup. Used by the daemon’s local-server spawn path; typically not set manually.
OMNIGENT_ADMIN_LIST_PATH<data_dir>/adminsPath to a plaintext file of admin identities (union’d with the config’s admins: list).

Accounts auth

Active when OMNIGENT_AUTH_ENABLED=1 and no OIDC issuer is set (or OMNIGENT_AUTH_PROVIDER=accounts).
VariableDefaultDescription
OMNIGENT_ACCOUNTS_COOKIE_SECRET(auto-generated)32-byte hex cookie secret. bootstrap.sh generates this; or openssl rand -hex 32. Persisted to the artifact dir on auto-generate so it survives restarts.
OMNIGENT_ACCOUNTS_BASE_URLhttp://<host>:<port>Public URL where users reach the server. Used to build magic-redeem URLs and to decide whether session cookies use the __Host- prefix. Must be set for any deploy behind a public domain.
OMNIGENT_ACCOUNTS_INIT_ADMIN_PASSWORDPre-seed the initial admin password non-interactively. Only takes effect on the very first boot; ignored with a warning if an admin already exists. Equivalent to omnigent server --admin-password.
OMNIGENT_ACCOUNTS_SESSION_TTL_HOURS8Session cookie lifetime in hours.
OMNIGENT_ACCOUNTS_INVITE_TTL_HOURS72Invite link lifetime in hours.
OMNIGENT_ACCOUNTS_MAGIC_TTL_MINUTES10Magic-redeem link lifetime in minutes.
OMNIGENT_ACCOUNTS_AUTO_OPEN1When 1, opens the magic-redeem URL in the browser on first boot. Set to 0 for headless / SSH / Docker deployments.

OIDC / SSO

Active when OMNIGENT_AUTH_ENABLED=1 and OMNIGENT_OIDC_ISSUER is set (or OMNIGENT_AUTH_PROVIDER=oidc).
VariableDefaultDescription
OMNIGENT_OIDC_ISSUEROIDC provider issuer URL, e.g. https://accounts.google.com, https://github.com, or your Okta/Entra/Keycloak URL. The presence of this variable (with auth enabled) selects OIDC mode automatically.
OMNIGENT_OIDC_CLIENT_IDOAuth app client ID from your identity provider.
OMNIGENT_OIDC_CLIENT_SECRETOAuth app client secret from your identity provider.
OMNIGENT_OIDC_COOKIE_SECRET32-byte hex cookie secret for OIDC sessions. bootstrap.sh generates this.
OMNIGENT_DOMAINYour server’s public domain (e.g. agents.yourcompany.com). Used to derive the OIDC callback URL (https://<domain>/auth/callback). Register this URL as the callback in your IdP app.
OMNIGENT_OIDC_ALLOWED_DOMAINSComma-separated list of email domains allowed to sign in, e.g. example.com,subsidiary.example.com. Union’d with the config’s allowed_domains: list and the <data_dir>/allowed_domains file.
OMNIGENT_OIDC_ALLOWED_DOMAINS_PATH<data_dir>/allowed_domainsOverride path for the allowed-domains file.
OMNIGENT_OIDC_SCOPESopenid email profileOIDC scopes to request. Override only if your provider requires non-standard scopes.
OMNIGENT_OIDC_SESSION_TTL_HOURS8OIDC session cookie lifetime in hours.
OMNIGENT_OIDC_LOGOUT_REDIRECT_URIURL to redirect to after OIDC logout.
OMNIGENT_OIDC_ALLOW_INVITESSet to 1 to enable single-use invite links (POST /auth/invite) for letting external collaborators in past ALLOWED_DOMAINS.

Model credentials

Passed through to harness SDKs. The CLI stores these in the OS keychain via omnigent setup; set them as environment variables to override or for CI environments.
VariableDescription
ANTHROPIC_API_KEYAnthropic API key for Claude SDK and Claude-native harnesses.
ANTHROPIC_AUTH_TOKENAlternative bearer token for Anthropic API access.
ANTHROPIC_BASE_URLOverride the Anthropic API base URL (e.g. for a gateway proxy).
CLAUDE_CODE_OAUTH_TOKENLong-lived OAuth token for Claude Code (from claude setup-token). Used when authenticating via a Claude subscription instead of an API key.
OPENAI_API_KEYOpenAI API key for the OpenAI Agents and Codex harnesses.
OPENAI_BASE_URLOverride the OpenAI API base URL (e.g. for an OpenAI-compatible gateway).
CODEX_ACCESS_TOKENCodex access token for ChatGPT Business/Enterprise plan users.
OPENAI_ORG_ID / OPENAI_ORGANIZATIONOpenAI organization ID.
COHERE_API_KEYCohere API key.
DEEPSEEK_API_KEYDeepSeek API key.
GEMINI_API_KEY / GOOGLE_API_KEYGoogle Gemini API key.
GROQ_API_KEYGroq API key.
MISTRAL_API_KEYMistral API key.
OPENROUTER_API_KEYOpenRouter API key.
PERPLEXITY_API_KEYPerplexity API key.
TOGETHER_API_KEYTogether AI API key.
VOYAGE_API_KEYVoyage AI API key.
XAI_API_KEYxAI API key.
DATABRICKS_*Databricks SDK configuration variables (host, token, profile, etc.) recognized by databricks-sdk.
AZURE_OPENAI_*Azure OpenAI configuration variables.

Sandbox providers

Required when using cloud sandboxes for managed host sessions.

Daytona

Install: pip install 'omnigent[daytona]'
VariableDescription
DAYTONA_API_KEYDaytona API key for provisioning cloud sandboxes.
OMNIGENT_DAYTONA_HOST_IMAGEOverride the host image used for Daytona sandboxes. Defaults to the official prebaked host image.

Modal

Install: pip install 'omnigent[modal]'Modal credentials are configured with modal token new (stores ~/.modal.toml) or via the variables below for server-side managed sandboxes.
VariableDescription
MODAL_TOKEN_IDModal token ID for server-side sandbox provisioning.
MODAL_TOKEN_SECRETModal token secret.
OMNIGENT_MODAL_HOST_IMAGEOverride the Modal host image ref for CLI-launched sandboxes.
OMNIGENT_MODAL_REGISTRY_SECRETName of a Modal secret holding REGISTRY_USERNAME / REGISTRY_PASSWORD for private registries.

Telemetry and tracing

VariableDefaultDescription
OTEL_EXPORTER_OTLP_ENDPOINTOpenTelemetry OTLP endpoint. When set, the server initializes OpenTelemetry observability. No-op when unset.
MLflow tracing support is available via the omnigent[tracing] extra. After installing it, traces are emitted automatically when MLFLOW_TRACKING_URI is configured and the omnigent[tracing] package is present.

Docker Compose

The deploy/docker/.env file (generated by bootstrap.sh) exposes several compose-specific variables.
VariableDefaultDescription
POSTGRES_PASSWORDchange-me-pleasePostgreSQL password. Run ./bootstrap.sh to auto-generate a strong value.
POSTGRES_USERomnigentPostgreSQL username.
POSTGRES_DBomnigentPostgreSQL database name.
OMNIGENT_PORT8000Host port the Omnigent container is published on.
OMNIGENT_IMAGEghcr.io/omnigent-ai/omnigent-serverDocker image to pull.
OMNIGENT_IMAGE_TAGlatestImage tag. Pin to a specific commit SHA (e.g. sha-abc1234) for reproducible deploys.

Internal CLI variables

These variables are used internally by the CLI and daemon process management. They are not typically set manually.
VariableDescription
OMNIGENT_CLAUDE_STARTUP_PROFILESet to 1 to print Claude startup timing marks to stderr. Equivalent to omnigent claude --profile-startup.
OMNIGENT_RUNNER_ENV_PASSTHROUGHComma-separated list of extra environment variable names the host should forward to runner subprocesses, e.g. NAME1,NAME2. Useful for gateway credentials or custom vars beyond the standard set when using managed sandboxes.
RUNNER_SERVER_URLServer URL injected into runner subprocess environments by the CLI.

Build docs developers (and LLMs) love