Skip to content

Commit 4e6408a

Browse files
authored
docs: prefer AGENT_CONTROL_DB_URL in configuration docs (#31)
* docs: prefer AGENT_CONTROL_DB_URL in config docs * docs: remove db alias wording * docs: simplify db config label
1 parent bfd6c98 commit 4e6408a

3 files changed

Lines changed: 14 additions & 15 deletions

File tree

components/server.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,9 @@ agent-control-server
5555
Create a `.env` file in the `server/` directory:
5656

5757
```env
58-
# Database (use DATABASE_URL for Docker, DB_URL for local dev)
59-
DATABASE_URL=postgresql+psycopg://user:password@localhost/agent_control
60-
# DB_URL=postgresql+psycopg://user:password@localhost/agent_control
61-
# DB_URL=sqlite+aiosqlite:///./agent_control.db
58+
# Database
59+
AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@localhost/agent_control
60+
# AGENT_CONTROL_DB_URL=sqlite+aiosqlite:///./agent_control.db
6261
6362
# Server settings
6463
HOST=0.0.0.0
@@ -269,7 +268,7 @@ make typecheck
269268
docker build -f server/Dockerfile -t agent-control-server .
270269

271270
docker run -p 8000:8000 \
272-
-e DATABASE_URL=postgresql+psycopg://user:password@host:5432/agent_control \
271+
-e AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@host:5432/agent_control \
273272
-e AGENT_CONTROL_API_KEY_ENABLED=true \
274273
-e AGENT_CONTROL_API_KEYS=your-key-here \
275274
-e AGENT_CONTROL_ADMIN_API_KEYS=your-admin-key-here \

core/configuration.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ icon: "gear"
1010
|----------|---------|-------------|
1111
| `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL |
1212
| `AGENT_CONTROL_API_KEY` || API key for authentication |
13-
| `DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Database connection string (SQLite: `sqlite+aiosqlite:///./agent_control.db`) |
13+
14+
For server database configuration, use the `AGENT_CONTROL_DB_*` variables in the server section below.
1415

1516
---
1617

@@ -38,14 +39,13 @@ icon: "gear"
3839

3940
| Variable | Default | Description |
4041
|----------|---------|-------------|
41-
| `DATABASE_URL` || Database URL for Docker deployments |
42-
| `DB_HOST` | `localhost` | PostgreSQL host |
43-
| `DB_PORT` | `5432` | PostgreSQL port |
44-
| `DB_USER` | `agent_control` | Database user |
45-
| `DB_PASSWORD` | `agent_control` | Database password |
46-
| `DB_DATABASE` | `agent_control` | Database name |
47-
| `DB_DRIVER` | `psycopg` | Database driver |
48-
| `DB_URL` || Database URL (legacy; overrides individual settings above) |
42+
| `AGENT_CONTROL_DB_URL` || Preferred database URL. Supports PostgreSQL and SQLite (for example `sqlite+aiosqlite:///./agent_control.db`). |
43+
| `AGENT_CONTROL_DB_HOST` | `localhost` | PostgreSQL host when `AGENT_CONTROL_DB_URL` is unset |
44+
| `AGENT_CONTROL_DB_PORT` | `5432` | PostgreSQL port when `AGENT_CONTROL_DB_URL` is unset |
45+
| `AGENT_CONTROL_DB_USER` | `agent_control` | Database user when `AGENT_CONTROL_DB_URL` is unset |
46+
| `AGENT_CONTROL_DB_PASSWORD` | `agent_control` | Database password when `AGENT_CONTROL_DB_URL` is unset |
47+
| `AGENT_CONTROL_DB_DATABASE` | `agent_control` | Database name when `AGENT_CONTROL_DB_URL` is unset |
48+
| `AGENT_CONTROL_DB_DRIVER` | `psycopg` | Database driver when `AGENT_CONTROL_DB_URL` is unset |
4949

5050
### Observability
5151

core/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ _Performance tested on Apple M5 (16 GB RAM), Docker Compose (`postgres:16` + `ag
253253
|----------|---------|-------------|
254254
| `AGENT_CONTROL_URL` | `http://localhost:8000` | Server URL for SDK |
255255
| `AGENT_CONTROL_API_KEY` || API key for authentication (if enabled) |
256-
| `DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Database connection string (SQLite: `sqlite+aiosqlite:///./agent_control.db`) |
256+
| `AGENT_CONTROL_DB_URL` | `postgresql+psycopg://agent_control:agent_control@localhost:5432/agent_control` | Server database URL (SQLite: `sqlite+aiosqlite:///./agent_control.db`) |
257257
| `GALILEO_API_KEY` || Required for Luna-2 AI evaluator |
258258

259259
### Server Configuration

0 commit comments

Comments
 (0)