Documentation

Environment variables

The environment variables obop reads: database URL, agent token, marketplace URL, and the settings of the control plane and Sliplane provisioner.

obop reads a small number of environment variables. Command line flags win over variables.

Instance and CLI ​

VariableMeaningDefault
OBOP_DATABASE_URLWhere the data lives: sqlite://obop.db, sqlite:///abs/path.db, postgres://user:pass@host/db or memory:. Same as --db.sqlite://obop.db
OBOP_TOKENBearer token for obop mcp, obop call and obop commands. Same as --token.none
OBOP_MARKETPLACE_URLAn extra marketplace: a host serving index.json and packages/<id>.toml. Shown after the bundled catalog.none
OBOP_PUBLIC_URLExternal URL of an instance behind a proxy (https://acme.example.com), used in the MCP discovery documents and in the 401 challenge of /mcp.from the request
OBOP_ALLOWED_ORIGINSComma-separated browser origins allowed to call /mcp (DNS-rebinding protection). Clients that are not browsers send no origin.none
OBOP_MCP_RATE_PER_MINUTERequests per token per minute on /mcp; 0 turns the limit off.600

Control plane ​

Used by obop platform serve.

VariableMeaning
OBOP_DATA_DIRWhere the local provisioner keeps instance data. Default obop-instances.
OBOP_IMAGE or OBOP_REPO (with OBOP_BRANCH, default main)Where instance services come from with the sliplane provisioner. A repository means Sliplane builds each instance; an image is faster.
OBOP_MARKETPLACE_URLOptional extra catalog for every instance.

Sliplane provisioner ​

--provisioner sliplane needs:

VariableMeaning
SLIPLANE_ACCOUNTAccount name the bundled Sliplane CLI is registered under.
SLIPLANE_API_KEYA Sliplane API key with write access. The container entrypoint registers it with the CLI and removes it from the environment. Set it as a secret.
OBOP_SLIPLANE_PROJECT, OBOP_SLIPLANE_SERVERWhere instance services go.
OBOP_CELL_ADMIN_URLpostgres:// superuser URL of the shared PostgreSQL server, as the control plane reaches it.
OBOP_CELL_INSTANCE_HOSThost:port that instances use to reach that server, for example obop-postgres.internal:5432.

Build time (the website) ​

VariableMeaning
OBOP_SITE_URLPublic origin used for canonical links, the sitemap and social cards when building this website. Default: https://obop-platform.sliplane.app.

Tests ​

OBOP_TEST_POSTGRES_URL adds PostgreSQL to cargo test. OBOP_BIN points the end-to-end suite at a built binary.