The Doubleword Control Layer (dwctl)

# dwctl configuration
# Secret key for jwt signing.
# TODO: Must be set in production! Required when native auth is enabled.
# secret_key: null  # Not set by default - must be provided via env var or config

# Admin user email - will be created on first startup
admin_email: "test@doubleword.ai"
# TODO: Change this in production!
admin_password: "hunter2"

# Authentication configuration
auth:
  # Native username/password authentication. Stores users in the local #
  # database, and allows them to login with username and password at
  # http://<host>:<port>/login
  native:
    enabled: true # Enable native login system
    # Whether users can sign up themselves. Defaults to false for security.
    # If false, the admin can create new users via the interface or API.
    allow_registration: false
    # Constraints on user passwords created during registration
    password:
      min_length: 8
      max_length: 64
    # Parameters for login session cookies.
    session:
      timeout: "24h"
      cookie_name: "dwctl_session"
      cookie_secure: true
      cookie_same_site: "strict"
    # Email configuration for password resets and notifications
    email:
      # Email transport - either 'file' (for development) or 'smtp' (for production)
      type: file
      path: "./emails" # Directory for file-based email (when type=file)
      # For SMTP (production), use:
      # type: smtp
      # host: "smtp.example.com"
      # port: 587
      # username: "noreply@example.com"
      # password: "your-smtp-password"
      # use_tls: true
      from_email: "noreply@example.com"
      from_name: "Control Layer"
      password_reset:
        token_expiry: "30m" # How long reset tokens are valid
        base_url: "http://localhost:3001" # Frontend URL for reset links

  # Proxy header authentication
  # Accepts user identity from HTTP headers set by an upstream authentication proxy
  # (e.g., oauth2-proxy, Vouch, Authentik, Auth0)
  #
  # Two modes:
  #   Single header: Send only header_name with user's email (must be unique)
  #   Dual header: Send both header_name (IdP identifier) and email_header_name (email)
  #                Allows multiple accounts per email from different identity providers
  proxy_header:
    enabled: false
    # header_name: User identifier or email
    # Single header mode: User's email (e.g., "user@example.com")
    # Dual header mode: Unique identifier from IdP (e.g., "github|user123", "google-oauth2|456")
    header_name: "x-doubleword-user"
    # email_header_name: User's email address (optional, enables dual header mode)
    # If provided: Enables federated identity with (email, external_user_id) uniqueness
    # If omitted: Uses header_name value as email (single header mode, email must be unique)
    email_header_name: "x-doubleword-email"
    # Groups and SSO provider headers (optional)
    groups_field_name: "x-doubleword-user-groups"
    provider_field_name: "x-doubleword-sso-provider"
    import_idp_groups: false # Import IdP groups
    blacklisted_sso_groups: []  # SSO groups to ignore
    # auto_create_users: Automatically create users on first login
    auto_create_users: true

  # Security settings
  security:
    # How long session cookies are valid for. After this much time, users will
    # have to log in again. Note: this is related to the
    # auth.native.session.timeout # value. That one configures how long the browser
    # will set the cookie for, this one how long the server will accept it for.
    jwt_expiry: "24h"
    # CORS Settings. In production, make sure your frontend URL is listed here.
    cors:
      allowed_origins:
        - "http://localhost:3001" # Default - Control Layer server itself
      allow_credentials: true
      max_age: 3600 # Cache preflight requests for 1 hour

# Model sources - the default inference endpoints that are shown in the UI.
# These are seeded into the database on first boot, and thereafter should be 
# managed in the UI, rather than here.
model_sources: []

# Example configurations:
# model_sources:
#   # OpenAI API
#   - name: "openai"
#     url: "https://api.openai.com"
#     api_key: "sk-..."  # Required for model sync
#
#   # Internal model server (no auth required)
#   - name: "internal"
#     url: "http://localhost:8080"

# Frontend metadata. This is just for display purposes, but can be useful to
# give information to users that manage your Control Layer deployment.
metadata:
  region: "UK South"
  organization: "ACME Corp"


# Server configuration
# To advertise publically, set to "0.0.0.0", or the specific network interface
# you've exposed.
host: "0.0.0.0"
port: 3001

# Database configuration
database:
  # By default, we connect to an external postgres database
  type: external
  # Override this with your own database url. Can also be configured via the
  # DATABASE_URL environment variable.
  url: "postgres://localhost:5432/control_layer"

  # Optional: Read replica URL for read-heavy operations
  # replica_url: "postgres://replica:5432/control_layer"

  # Main database connection pool settings
  # pool:
  #   max_connections: 10
  #   min_connections: 0
  #   acquire_timeout_secs: 30
  #   idle_timeout_secs: 600
  #   max_lifetime_secs: 1800

  # Component databases: fusillade (batch processing) and outlet (request logging)
  # By default, these use separate schemas within the main database.
  # You can optionally configure them to use dedicated databases.

  # Fusillade - batch processing database
  # Default: uses "fusillade" schema in main database
  # fusillade:
  #   mode: schema
  #   name: fusillade
  #   pool:
  #     max_connections: 20
  #
  # Alternative: use a dedicated database
  # fusillade:
  #   mode: dedicated
  #   url: postgres://localhost:5432/fusillade
  #   replica_url: postgres://replica:5432/fusillade
  #   pool:
  #     max_connections: 20

  # Outlet - request logging database
  # Default: uses "outlet" schema in main database
  # outlet:
  #   mode: schema
  #   name: outlet
  #   pool:
  #     max_connections: 5

  # Alternatively, you can use embedded postgres (requires compiling with the
  # embedded-db feature, which is not present in the default docker image)
  # type: embedded
  # data_dir: null  # Optional: directory for database storage
  # persistent: false  # Set to true to persist data between restarts


# By default, we log all requests and responses to the database. This is
# performed asynchronously, so there's very little performance impact. # If
# you'd like to disable this (if you have sensitive data in your
# request/responses, for example), toggle this flag.
enable_request_logging: true # Enable request/response logging to database

# Batches API configuration
# The batches API provides OpenAI-compatible batch processing endpoints
# Batches can be sent containing requests to any model configured in the
# control layer, and they'll be executed asynchronously over the course of 24
# hours.
batches:
  # Enable batches API endpoints (/ai/v1/files, /ai/v1/batches)
  # When disabled, these endpoints will not be available (default: false).
  enabled: false

  # Daemon configuration for processing batch requests
  daemon:
    # Controls when the batch processing daemon runs
    # - "leader": Only run on the elected leader instance (default)
    # - "always": Run on all instances (use for single-instance deployments)
    # - "never": Never run the daemon (useful for testing or when using external processors)
    enabled: leader

    # Performance & Concurrency Settings
    claim_batch_size: 100 # Maximum number of requests to claim in each iteration
    default_model_concurrency: 10 # Default concurrent requests per model
    claim_interval_ms: 1000 # Milliseconds to sleep between claim iterations

    # Retry & Backoff Settings
    # All retry parameters are optional - default behaviour is to retry indefinitely until deadline
    # max_retries: 100 # stop retrying a request after 100 failed attempts
    # stop_before_deadline_ms: 900000 # Stop 15 minutes before batch deadline
    
    backoff_ms: 1000 # Initial backoff duration in milliseconds
    backoff_factor: 2 # Exponential backoff multiplier
    max_backoff_ms: 10000 # Maximum backoff duration in milliseconds

    # Timeout Settings
    # timeout_ms: 600000 # DEPRECATED: splits into 90% first_chunk_timeout_ms, 10% body_timeout_ms
    first_chunk_timeout_ms: 86400000 # Max time waiting for response headers (24 hours)
    chunk_timeout_ms: 86400000 # Max idle time between response body chunks (24 hours)
    body_timeout_ms: 86400000 # Max total time for entire response body (24 hours)
    claim_timeout_ms: 60000 # Max time in "claimed" state before auto-unclaim (1 minute)
    processing_timeout_ms: 600000 # Max time in "processing" state before auto-unclaim (10 minutes)

    # Observability
    status_log_interval_ms: 2000 # Interval for logging daemon status (set to null to disable)

  # Files configuration for batch file uploads/downloads
  files:
    max_file_size: 2147483648 # 2 GB - maximum size for file uploads
    upload_buffer_size: 100 # Buffer size for file upload streams
    download_buffer_size: 100 # Buffer size for file download streams

credits:
  initial_credits_for_standard_users: 50