Skip to content

docs: prefer AGENT_CONTROL_DB_URL in configuration docs #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lan17 merged 3 commits into from
Mar 16, 2026
Merged

docs: prefer AGENT_CONTROL_DB_URL in configuration docs #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4649d9e
docs: prefer AGENT_CONTROL_DB_URL in config docs
lan17 Mar 16, 2026
1ac9fcd
docs: remove db alias wording
lan17 Mar 16, 2026
3b1acd3
docs: simplify db config label
lan17 Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions components/server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,9 @@ 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
AGENT_CONTROL_DB_URL=postgresql+psycopg://user:password@localhost/agent_control
# AGENT_CONTROL_DB_URL=sqlite+aiosqlite:///./agent_control.db

# Server settings
HOST=0.0.0.0
Expand Down Expand Up @@ -269,7 +268,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 \
Expand Down
18 changes: 9 additions & 9 deletions core/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down Expand Up @@ -38,14 +39,13 @@ 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 |

### Observability

Expand Down
2 changes: 1 addition & 1 deletion core/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` | Server database URL (SQLite: `sqlite+aiosqlite:///./agent_control.db`) |
| `GALILEO_API_KEY` | — | Required for Luna-2 AI evaluator |

### Server Configuration
Expand Down
Loading