config.example.yaml

# codex-oauth-proxy server bind host.
host: "127.0.0.1"

# Server port.
port: 8317

# Existing Codex auth JSON files are loaded from this directory.
# The official Codex CLI ~/.codex/auth.json format is supported directly.
auth-dir: "~/.codex"

# Enable request and proxy debug logs. Secrets are masked.
debug: false

# Admin API key for /v0/management endpoints. Leave empty to disable them.
admin-api-key: ""

# SQLite database for managed users and generated user API keys.
# Empty path resolves to <auth-dir>/codex-oauth-proxy.db.
database:
  path: ""

# Local usage accounting for managed user API keys.
usage:
  enabled: true
  debug-openai-response: false

# Allow Codex Fast mode. Disabled by default because Fast mode consumes credits
# at a higher rate. When false, Fast tier metadata is hidden and explicit
# service_tier="fast" or service_tier="priority" requests are rejected.
allow-fast-mode: false

# Optional outbound proxy. Use "direct" or "none" to bypass proxy settings.
proxy-url: ""

# Number of additional cooldown retry rounds after the initial credential round.
request-retry: 3

# Maximum distinct Codex credentials tried in one round. 0 tries all eligible.
max-retry-credentials: 0

# Maximum seconds to wait for the nearest auth cooldown. 0 disables waiting.
max-retry-interval: 30

# Codex upstream base URL.
codex-base-url: "https://chatgpt.com/backend-api/codex"

# ChatGPT backend base URL used by Codex file uploads.
chatgpt-base-url: "https://chatgpt.com/backend-api"

# Optional upstream User-Agent override. Its version is the default model catalog version.
codex-user-agent: ""

# Optional x-codex-beta-features fallback.
codex-beta-features: ""

# Optional Codex OAuth refresh token endpoint override.
codex-refresh-token-url: ""