From 4649d9eedf86da60d9bcaf5a4914d6ab47c709ec Mon Sep 17 00:00:00 2001 From: Lev Neiman Date: Mon, 16 Mar 2026 14:08:52 -0700 Subject: [PATCH 1/3] docs: prefer AGENT_CONTROL_DB_URL in config docs --- components/server.mdx | 10 +++++----- core/configuration.mdx | 26 +++++++++++++++++--------- core/quickstart.mdx | 2 +- 3 files changed, 23 insertions(+), 15 deletions(-) diff --git a/components/server.mdx b/components/server.mdx index 0356aa5..8219265 100644 --- a/components/server.mdx +++ b/components/server.mdx @@ -55,10 +55,10 @@ agent-control-server Create a `.env` file in the `server/` directory: ```env -# Database (use DATABASE_URL for Docker, DB_URL for local dev) -DATABASE_URL=postgresql+psycopg://user:password@localhost/agent_control -# DB_URL=postgresql+psycopg://user:password@localhost/agent_control -# DB_URL=sqlite+aiosqlite:///./agent_control.db +# Database (preferred single-variable form) +AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@localhost/agent_control +# AGENT_CONTROL_DB_URL=sqlite+aiosqlite:///./agent_control.db +# Legacy aliases DATABASE_URL and DB_URL are still accepted # Server settings HOST=0.0.0.0 @@ -269,7 +269,7 @@ make typecheck docker build -f server/Dockerfile -t agent-control-server . docker run -p 8000:8000 \ - -e DATABASE_URL=postgresql+psycopg://user:password@host:5432/agent_control \ + -e AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@host:5432/agent_control \ -e AGENT_CONTROL_API_KEY_ENABLED=true \ -e AGENT_CONTROL_API_KEYS=your-key-here \ -e AGENT_CONTROL_ADMIN_API_KEYS=your-admin-key-here \ diff --git a/core/configuration.mdx b/core/configuration.mdx index 0ac01d7..bc8d158 100644 --- a/core/configuration.mdx +++ b/core/configuration.mdx @@ -10,7 +10,8 @@ icon: "gear" |----------|---------|-------------| | `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL | | `AGENT_CONTROL_API_KEY` | — | API key for authentication | -| `DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Database connection string (SQLite: `sqlite+aiosqlite:///./agent_control.db`) | + +For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the server section below. --- @@ -38,14 +39,21 @@ icon: "gear" | Variable | Default | Description | |----------|---------|-------------| -| `DATABASE_URL` | — | Database URL for Docker deployments | -| `DB_HOST` | `localhost` | PostgreSQL host | -| `DB_PORT` | `5432` | PostgreSQL port | -| `DB_USER` | `agent_control` | Database user | -| `DB_PASSWORD` | `agent_control` | Database password | -| `DB_DATABASE` | `agent_control` | Database name | -| `DB_DRIVER` | `psycopg` | Database driver | -| `DB_URL` | — | Database URL (legacy; overrides individual settings above) | +| `AGENT_CONTROL_DB_URL` | — | Preferred database URL. Supports PostgreSQL and SQLite (for example `sqlite+aiosqlite:///./agent_control.db`). | +| `AGENT_CONTROL_DB_HOST` | `localhost` | PostgreSQL host when `AGENT_CONTROL_DB_URL` is unset | +| `AGENT_CONTROL_DB_PORT` | `5432` | PostgreSQL port when `AGENT_CONTROL_DB_URL` is unset | +| `AGENT_CONTROL_DB_USER` | `agent_control` | Database user when `AGENT_CONTROL_DB_URL` is unset | +| `AGENT_CONTROL_DB_PASSWORD` | `agent_control` | Database password when `AGENT_CONTROL_DB_URL` is unset | +| `AGENT_CONTROL_DB_DATABASE` | `agent_control` | Database name when `AGENT_CONTROL_DB_URL` is unset | +| `AGENT_CONTROL_DB_DRIVER` | `psycopg` | Database driver when `AGENT_CONTROL_DB_URL` is unset | +| `DATABASE_URL` | — | Legacy alias for `AGENT_CONTROL_DB_URL` | +| `DB_URL` | — | Legacy alias for `AGENT_CONTROL_DB_URL` | +| `DB_HOST` | `localhost` | Legacy alias for `AGENT_CONTROL_DB_HOST` | +| `DB_PORT` | `5432` | Legacy alias for `AGENT_CONTROL_DB_PORT` | +| `DB_USER` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_USER` | +| `DB_PASSWORD` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_PASSWORD` | +| `DB_DATABASE` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_DATABASE` | +| `DB_DRIVER` | `psycopg` | Legacy alias for `AGENT_CONTROL_DB_DRIVER` | ### Observability diff --git a/core/quickstart.mdx b/core/quickstart.mdx index 998d7ee..3d98bc6 100644 --- a/core/quickstart.mdx +++ b/core/quickstart.mdx @@ -253,7 +253,7 @@ _Performance tested on Apple M5 (16 GB RAM), Docker Compose (`postgres:16` + `ag |----------|---------|-------------| | `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL for SDK | | `AGENT_CONTROL_API_KEY` | — | API key for authentication (if enabled) | -| `DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Database connection string (SQLite: `sqlite+aiosqlite:///./agent_control.db`) | +| `AGENT_CONTROL_DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Preferred server database URL (SQLite: `sqlite+aiosqlite:///./agent_control.db`). Legacy aliases `DATABASE_URL` and `DB_URL` are still accepted. | | `GALILEO_API_KEY` | — | Required for Luna-2 AI evaluator | ### Server Configuration From 1ac9fcd9a7ad82135ce7ac7643247e4ddb9f4b2a Mon Sep 17 00:00:00 2001 From: Lev Neiman Date: Mon, 16 Mar 2026 14:15:22 -0700 Subject: [PATCH 2/3] docs: remove db alias wording --- components/server.mdx | 1 - core/configuration.mdx | 8 -------- core/quickstart.mdx | 2 +- 3 files changed, 1 insertion(+), 10 deletions(-) diff --git a/components/server.mdx b/components/server.mdx index 8219265..007f1e3 100644 --- a/components/server.mdx +++ b/components/server.mdx @@ -58,7 +58,6 @@ Create a `.env` file in the `server/` directory: # Database (preferred single-variable form) AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@localhost/agent_control # AGENT_CONTROL_DB_URL=sqlite+aiosqlite:///./agent_control.db -# Legacy aliases DATABASE_URL and DB_URL are still accepted # Server settings HOST=0.0.0.0 diff --git a/core/configuration.mdx b/core/configuration.mdx index bc8d158..3d64381 100644 --- a/core/configuration.mdx +++ b/core/configuration.mdx @@ -46,14 +46,6 @@ For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the | `AGENT_CONTROL_DB_PASSWORD` | `agent_control` | Database password when `AGENT_CONTROL_DB_URL` is unset | | `AGENT_CONTROL_DB_DATABASE` | `agent_control` | Database name when `AGENT_CONTROL_DB_URL` is unset | | `AGENT_CONTROL_DB_DRIVER` | `psycopg` | Database driver when `AGENT_CONTROL_DB_URL` is unset | -| `DATABASE_URL` | — | Legacy alias for `AGENT_CONTROL_DB_URL` | -| `DB_URL` | — | Legacy alias for `AGENT_CONTROL_DB_URL` | -| `DB_HOST` | `localhost` | Legacy alias for `AGENT_CONTROL_DB_HOST` | -| `DB_PORT` | `5432` | Legacy alias for `AGENT_CONTROL_DB_PORT` | -| `DB_USER` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_USER` | -| `DB_PASSWORD` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_PASSWORD` | -| `DB_DATABASE` | `agent_control` | Legacy alias for `AGENT_CONTROL_DB_DATABASE` | -| `DB_DRIVER` | `psycopg` | Legacy alias for `AGENT_CONTROL_DB_DRIVER` | ### Observability diff --git a/core/quickstart.mdx b/core/quickstart.mdx index 3d98bc6..401de7e 100644 --- a/core/quickstart.mdx +++ b/core/quickstart.mdx @@ -253,7 +253,7 @@ _Performance tested on Apple M5 (16 GB RAM), Docker Compose (`postgres:16` + `ag |----------|---------|-------------| | `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL for SDK | | `AGENT_CONTROL_API_KEY` | — | API key for authentication (if enabled) | -| `AGENT_CONTROL_DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Preferred server database URL (SQLite: `sqlite+aiosqlite:///./agent_control.db`). Legacy aliases `DATABASE_URL` and `DB_URL` are still accepted. | +| `AGENT_CONTROL_DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Server database URL (SQLite: `sqlite+aiosqlite:///./agent_control.db`) | | `GALILEO_API_KEY` | — | Required for Luna-2 AI evaluator | ### Server Configuration From 3b1acd39cb7255bd98073bf4caaa1aef14b0de63 Mon Sep 17 00:00:00 2001 From: Lev Neiman Date: Mon, 16 Mar 2026 14:16:30 -0700 Subject: [PATCH 3/3] docs: simplify db config label --- components/server.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/server.mdx b/components/server.mdx index 007f1e3..f74a424 100644 --- a/components/server.mdx +++ b/components/server.mdx @@ -55,7 +55,7 @@ agent-control-server Create a `.env` file in the `server/` directory: ```env -# Database (preferred single-variable form) +# Database AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@localhost/agent_control # AGENT_CONTROL_DB_URL=sqlite+aiosqlite:///./agent_control.db