Skip to content

docs(server): Update README.md #168

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
Apr 8, 2026
Merged

docs(server): Update README.md #168

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91e5f95
Update README.md
lan17 Apr 8, 2026
6a1cdf1
Update README.md
lan17 Apr 8, 2026
ce6b0b7
Update README.md
lan17 Apr 8, 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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,23 +64,23 @@ curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/
```

This starts PostgreSQL and Agent Control at `http://localhost:8000`, including
the UI/dashboard.
the UI/dashboard.

To override the exposed host ports, set `AGENT_CONTROL_SERVER_HOST_PORT` and/or
`AGENT_CONTROL_DB_HOST_PORT` before starting Compose. Example:
Note: This starts server without API keys configured which is dangerous for any real world usage.

Set appropirate env vars to override defaults like:
* Exposed ports
* Agent and admin API keys
* Postgres DB Password

```bash
export AGENT_CONTROL_SERVER_HOST_PORT=18000
export AGENT_CONTROL_DB_HOST_PORT=15432
curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/main/docker-compose.yml | docker compose -f - up -d
```
export AGENT_CONTROL_API_KEY_ENABLED=true
export AGENT_CONTROL_API_KEYS="agent-api-key"
export AGENT_CONTROL_ADMIN_API_KEYS="admin-api-key"
export AGENT_CONTROL_POSTGRES_PASSWORD="postgres-password"

To override the bundled PostgreSQL password, set
`AGENT_CONTROL_POSTGRES_PASSWORD` before starting Compose. This value is used
for both the Postgres container and the server's database connection. Example:

```bash
export AGENT_CONTROL_POSTGRES_PASSWORD=agent_control_local
curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/main/docker-compose.yml | docker compose -f - up -d
```

Expand Down
Loading