Deployment
Environment Variables
YOKE_STORAGE, DATABASE_URL, worker config, S3, multi-tenant, and scaling environment reference.
Required
| Variable | Purpose |
|---|---|
DATABASE_URL | Postgres connection string |
YOKE_STORAGE | pg_sqlite or s3 — per-instance SQLite backend |
Storage
| Variable | When | Purpose |
|---|---|---|
YOKE_STORAGE | Always | pg_sqlite (BYTEA in Postgres) or s3 |
YOKE_S3_BUCKET | s3 mode | S3 bucket for actor SQLite + blobs |
YOKE_S3_PREFIX | Optional | Key prefix (default empty) |
YOKE_S3_SYNC | Optional | lazy (default) or strict fsync before upload |
Worker / Deno
| Variable | Default | Purpose |
|---|---|---|
YOKE_WORKER | (runtime default) | Worker entry script — rarely overridden when authoring packages |
YOKE_WORKER_PROJECT | (runtime default) | Deno project dir for worker deno.json |
Tenant / package
| Variable | Default | Purpose |
|---|---|---|
YOKE_TENANT_ID | default | Tenant scope for all ops |
YOKE_PACKAGE_REF | S3/git ref to user package (hosted) |
Horizontal scaling
| Variable | Default | Purpose |
|---|---|---|
YOKE_WORKER_ID | {hostname}-{uuid} | Stable worker identity for queue ownership |
Deployment mode
| Variable | Default | Purpose |
|---|---|---|
YOKE_DEPLOYMENT | distributed | colocated or distributed — set automatically by yoke run |
YOKE_SANDBOX | docker | in_process (colocated) or Docker sandbox provider |
YOKE_SCALE_TO_ZERO | 1 | 0 disables scale-to-zero (colocated single-tenant) |
YOKE_EMBEDDED_PACKAGE_DIR | temp dir | Override where deploy binaries extract embedded packages |
Multi-tenant hosted
| Variable | Purpose |
|---|---|
YOKE_LEASE_HOLDER | Executor lease identity for heartbeat |
YOKE_CONTROL_PLANE_PORT | Control plane HTTP (default 8090) |
LLM providers (user package)
Set in Deno env, read by user package at runtime:
| Variable | Provider |
|---|---|
OPENAI_API_KEY | createOpenAiProvider |
ANTHROPIC_API_KEY | createAnthropicProvider |
Example — local dev
export DATABASE_URL=postgres://yoke:yoke@localhost:5432/yoke
export YOKE_STORAGE=pg_sqliteExample — S3 production
export DATABASE_URL=postgres://...
export YOKE_STORAGE=s3
export YOKE_S3_BUCKET=my-yoke-state
export YOKE_S3_SYNC=strictExample — multi-tenant executor
export DATABASE_URL=postgres://...
export YOKE_TENANT_ID=customer-abc
export YOKE_STORAGE=s3
export YOKE_S3_BUCKET=my-yoke-state
export YOKE_S3_PREFIX=customer-abc
export YOKE_PACKAGE_REF=s3://packages/customer-abc/latest
export YOKE_LEASE_HOLDER=executor-pod-xyz