Skip to content

Commit 275d305

Browse files
authored
docs(server): Update README.md (#168)
## Summary - What changed and why. ## Scope - User-facing/API changes: - Internal changes: - Out of scope: ## Risk and Rollout - Risk level: low / medium / high - Rollback plan: ## Testing - [ ] Added or updated automated tests - [ ] Ran `make check` (or explained why not) - [ ] Manually verified behavior ## Checklist - [ ] Linked issue/spec (if applicable) - [ ] Updated docs/examples for user-facing changes - [ ] Included any required follow-up tasks
1 parent ec6253b commit 275d305

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,23 @@ curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/
6464
```
6565

6666
This starts PostgreSQL and Agent Control at `http://localhost:8000`, including
67-
the UI/dashboard.
67+
the UI/dashboard.
6868

69-
To override the exposed host ports, set `AGENT_CONTROL_SERVER_HOST_PORT` and/or
70-
`AGENT_CONTROL_DB_HOST_PORT` before starting Compose. Example:
69+
Note: This starts server without API keys configured which is dangerous for any real world usage.
70+
71+
Set appropirate env vars to override defaults like:
72+
* Exposed ports
73+
* Agent and admin API keys
74+
* Postgres DB Password
7175

7276
```bash
7377
export AGENT_CONTROL_SERVER_HOST_PORT=18000
7478
export AGENT_CONTROL_DB_HOST_PORT=15432
75-
curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/main/docker-compose.yml | docker compose -f - up -d
76-
```
79+
export AGENT_CONTROL_API_KEY_ENABLED=true
80+
export AGENT_CONTROL_API_KEYS="agent-api-key"
81+
export AGENT_CONTROL_ADMIN_API_KEYS="admin-api-key"
82+
export AGENT_CONTROL_POSTGRES_PASSWORD="postgres-password"
7783

78-
To override the bundled PostgreSQL password, set
79-
`AGENT_CONTROL_POSTGRES_PASSWORD` before starting Compose. This value is used
80-
for both the Postgres container and the server's database connection. Example:
81-
82-
```bash
83-
export AGENT_CONTROL_POSTGRES_PASSWORD=agent_control_local
8484
curl -L https://raw.githubusercontent.com/agentcontrol/agent-control/refs/heads/main/docker-compose.yml | docker compose -f - up -d
8585
```
8686

0 commit comments

Comments
 (0)