Configuration

Complete reference for oke.config.ts. Options below match defineConfig. Driver maps use three keys: dev · test · prod.

import { defineConfig } from "okengine/config";

export default defineConfig({
  // options below
});

Environments

Missing dev pins fill from prod (fillDevFromProd). Only dev / test / prod keys are valid — rename local → dev and docker → prod if you still have the old maps.

Quick start

import { defineConfig } from "okengine/config";

export default defineConfig({
  drivers: {
    // Default vault.dev is "env"; pin the built-in store for Docker-first apps.
    vault: { dev: "vault" },
  },
});

drivers: {
  signal: "redis", // → { dev: "redis", test: "redis", prod: "redis" }
},

oke dev    # Docker Compose + host Bun · drivers.dev
oke test   # bun test · NODE_ENV=test · OKE_PGLITE_URL=memory://

Default driver maps

Built-in defaults (DRIVER_DEFAULTS) when a key is omitted:

store.index, channel.whatsapp / push, and ai have no single three-env default table — set them explicitly when you need them. create-oke templates pin vault.dev: "vault" (built-in) because the default dev driver is env.

Driver keys and ids

Safety rules

defineConfig rejects unsafe pins:

• sqlite is removed — use postgres (dev/prod) or pglite (test).
• drivers.store.sql.test must be pglite when set — real Postgres semantics in tests.

Rich driver objects

sql: {
  prod: { driver: "postgres", pool: { max: 20 }, replicas: ["postgres://ro-1/db"] },
},

images

Nested pins by element role — vendor choice lives here, never in driver ids:

images: {
  store: {
    sql: "postgres:18-alpine",
    kv: "redis:8-alpine",
    files: "rustfs/rustfs:1.0.0-rc.5",
  },
  channel: { email: "axllent/mailpit:v1.31.1" },
  pgdog: "ghcr.io/pgdogdev/pgdog:v0.1.57",
  // proxy: "caddy:2-alpine",
},

Omitted image keys mean no container for that role. When both store.sql and pgdog are pinned, DATABASE_URL points at PgDog — see Store.

For store.kv, pin Redis (default), Valkey, or Dragonfly — driver id stays redis. { durable: true } KV lives in SQL (oke_kv on DATABASE_URL), not a second Redis image.

Compose does not manage AI inference — OpenRouter or BYO OKE_AI_URL (Models). For proxy, see Caddy, Traefik, or nginx.

i18n

i18n: { locales: ["en"], default: "en" },
// or with Arabic: { locales: ["en", "ar"], default: "en", dir: { ar: "rtl" } }

tenancy

oke.config.ts tenancy is isolation posture (how rows are separated). Identity — who the tenant is — is gate.auth.tenant on Gate.

privacy

Presence of this block turns CORE privacy tooling on in the Console — not a .plug() call.

privacy: {},

runs

Runs retention and redaction — not the same key as drivers.runs.

db

Domain schema sync for oke db push | generate | migrate (Drizzle). Unrelated to oke schema generate.

topology

ports

console

Troubleshooting

Learn more

• CLI — oke dev · oke test · oke db
• Environment Variables — URL and secret resolution
• Store — what the store drivers back
• i18n — locale catalogs beyond the config block

Next