> ## Documentation Index
> Fetch the complete documentation index at: https://agno-v2-service-account.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Docker Reference
> Commands, customization, environment variables, and troubleshooting for the self-hosted Docker template.
The Compose services are `agentos-api` (the app) and `agentos-db` (Postgres with pgvector). Production runs the same files plus the `compose.prod.yaml` override; the full flow is on the [deploy page](/deploy/templates/docker/deploy).
## Manage
| Task | Command |
| -------------------- | ------------------------------------------------------------------------------------ |
| Deploy code changes | `git pull`, then `docker compose -f compose.yaml -f compose.prod.yaml up -d --build` |
| Apply env changes | `docker compose -f compose.yaml -f compose.prod.yaml up -d` |
| Tail production logs | `docker compose -f compose.yaml -f compose.prod.yaml logs -f agentos-api` |
| Stop the platform | `docker compose down` (keeps the `pgdata` volume) |
| Tear down | `docker compose down -v` (deletes the `pgdata` volume and all platform data) |
## Production auth
Token-Based Authorization is on by default. Without a `JWT_VERIFICATION_KEY` or `JWT_JWKS_FILE`, the app refuses to serve traffic in production. The platform's job is to keep your data private, so the safe default is refuse to start.
Token-Based Auth gives you three things:
1. **No public access.** The server rejects requests without a valid token.
2. **Per-request identity.** Middleware parses the token and extracts the `user_id`, `session_id`, and custom claims. Each request is tied to a user and session, giving you auditability and traceability.
3. **Granular permissions.** User tokens can run an agent and view their own sessions. Admin tokens read everyone's sessions and test any agent.
To opt out (not recommended), set `authorization=False` in `app/main.py` and restart. Use this only inside a private network behind another auth layer. Without it, anyone who finds your public URL can access your platform.
## Customize
Ask your coding agent to run `/create-new-agent`, or do it by hand. Create `agents/my_agent.py`:
```python theme={null}
from agno.agent import Agent
from app.settings import default_model
from db import get_postgres_db
INSTRUCTIONS = """\
What the agent does, which tools it uses, the rules to follow when answering.
"""
my_agent = Agent(
id="my-agent",
name="My Agent",
model=default_model(),
db=get_postgres_db(),
instructions=INSTRUCTIONS,
enable_agentic_memory=True,
add_datetime_to_context=True,
add_history_to_context=True,
num_history_runs=5,
)
```
Register it in `app/main.py`:
```python theme={null}
from agents.my_agent import my_agent
agent_os = AgentOS(
...
agents=[agent_builder, platform_manager, web_search, my_agent],
)
```
Local containers hot-reload on save. For production, rebuild with `docker compose -f compose.yaml -f compose.prod.yaml up -d --build`.
`app/settings.py` defines `default_model()`, used by every agent. Change it in one place:
```python theme={null}
from agno.models.anthropic import Claude
def default_model():
return Claude(id="claude-sonnet-5")
```
Add `anthropic` to `pyproject.toml`, set the provider key in your env, and regenerate pins:
```bash theme={null}
./scripts/generate_requirements.sh
```
Rebuild locally with `docker compose up -d --build`. For production:
```bash theme={null}
docker compose -f compose.yaml -f compose.prod.yaml up -d --build
```
Agno ships 100+ toolkits. See [Toolkits](/tools/toolkits/overview).
```python theme={null}
from agno.tools.slack import SlackTools
my_agent = Agent(
...
tools=[SlackTools()],
)
```
1. Edit `pyproject.toml`.
2. Regenerate pins: `./scripts/generate_requirements.sh` (add `upgrade` to refresh every pin).
3. Rebuild locally with `docker compose up -d --build`, or in production with `docker compose -f compose.yaml -f compose.prod.yaml up -d --build`.
Set both variables in `.env`:
```bash theme={null}
SLACK_BOT_TOKEN=xoxb-...
SLACK_SIGNING_SECRET=...
```
Apply with `docker compose up -d` (in production, `docker compose -f compose.yaml -f compose.prod.yaml up -d`). The interface activates automatically and routes messages to Agent Builder; change the `agent=` argument in `app/main.py` to point at another agent. See [Slack setup](/agent-os/interfaces/slack/setup).
The deployment check runs daily by default (`ENABLE_DEPLOY_CHECK=True`); it is deterministic and free. Scheduled evals are off by default (`ENABLE_SCHEDULED_EVALS=False`) because they use model calls. Both workflows stay runnable on demand regardless.
## Format, validate, and run evals
The format, validate, and eval scripts run on the host and need a venv. Set it up once:
```bash theme={null}
./scripts/venv_setup.sh
source .venv/bin/activate
```
| Task | Command |
| ------------------- | ----------------------------- |
| Format | `./scripts/format.sh` |
| Lint and type-check | `./scripts/validate.sh` |
| Run smoke evals | `python -m evals --tag smoke` |
`./scripts/mcp_check.sh` runs inside the container, so it needs no venv.
## Environment variables
| Variable | Required | Default | Description |
| ------------------------------------------------------------- | ---------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OPENAI_API_KEY` | Yes | - | Models and embeddings. |
| `RUNTIME_ENV` | No | `prd` | `dev` disables JWT. `compose.yaml` sets `dev` for local; `compose.prod.yaml` sets `prd`. Never hand-set `dev` on a production host, or the platform serves unauthenticated. |
| `JWT_VERIFICATION_KEY` | Production | - | Public key from os.agno.com. Quote the value so the multi-line PEM parses as one variable. |
| `JWT_JWKS_FILE` | Production | - | Path to a JWKS file. Alternative to `JWT_VERIFICATION_KEY`. |
| `MCP_CONNECT_SECRET` | No | - | OAuth consent secret (16+ chars) for connecting claude.ai and ChatGPT to `/mcp`. Set it yourself in `.env`, e.g. `openssl rand -base64 32`. Dev reads the same file, so it gates the local `/mcp` too. |
| `AGENTOS_MCP_SIGNING_KEY` | No | generated | Optional high-entropy signing-key material (32+ chars) for OAuth tokens. Unset, a strong key is generated and persisted in the database. Rotating it invalidates outstanding tokens. |
| `AGENTOS_URL` | No | `http://127.0.0.1:8000` | Scheduler base URL. Set it in `.env` to your public URL; `compose.prod.yaml` passes it through. Left at the default in production, the daily deployment check flags the platform as misconfigured. Also the public origin OAuth metadata derives from when `MCP_CONNECT_SECRET` is set. |
| `ENABLE_DEPLOY_CHECK` | No | `True` | Daily deployment-check cron. |
| `ENABLE_SCHEDULED_EVALS` | No | `False` | Daily run-evals cron. Uses model calls. |
| `EVALS_TAG` | No | `smoke` | Eval tag the run-evals workflow runs. |
| `EVALS_CASE_TIMEOUT_SECONDS` | No | `90` | Per-case timeout for run-evals runs. |
| `EVALS_SUITE_TIMEOUT_SECONDS` | No | `900` | Whole-suite timeout for run-evals runs. |
| `PARALLEL_API_KEY` | No | - | WebSearch uses the Parallel SDK when set, keyless MCP otherwise. |
| `SLACK_BOT_TOKEN` | No | - | Set with the signing secret to enable Slack. |
| `SLACK_SIGNING_SECRET` | No | - | Set with the bot token to enable Slack. |
| `DB_HOST` / `DB_PORT` / `DB_USER` / `DB_PASS` / `DB_DATABASE` | No | matches compose | Postgres connection. Set a strong `DB_PASS` in production. |
| `DB_DRIVER` | No | `postgresql+psycopg` | SQLAlchemy driver. |
| `AGNO_DEBUG` | No | `False` | Verbose Agno logs. Compose sets it for dev. |
| `WAIT_FOR_DB` | No | `False` | If `True`, the entrypoint blocks on the database before starting. Compose sets it. |
## Troubleshooting
The first build takes a few minutes. Read `docker compose logs agentos-api` and fix what you find.
The production override uses Compose merge tags that need Docker Compose v2.24.4 or newer. Upgrade Docker Compose and rerun.
JWT auth is on whenever `RUNTIME_ENV` is not `dev`. Set `JWT_VERIFICATION_KEY` or `JWT_JWKS_FILE` in `.env` and recreate the container with `docker compose -f compose.yaml -f compose.prod.yaml up -d`. To opt out inside a private network behind another auth layer, set `authorization=False` in `app/main.py`.
Postgres reads the password only when the `pgdata` volume is first initialized. On a host that already ran the dev Compose, the database keeps the old password and the API blocks waiting for it. Change the password in place and set `.env` to match:
```bash theme={null}
docker compose exec agentos-db psql -U ai -c "ALTER USER ai WITH PASSWORD '';"
```
Or reinitialize with `docker compose down -v`, which deletes all platform data.
`AGENTOS_URL` is still the localhost default. Set it in `.env` to your public URL and recreate the container with `docker compose -f compose.yaml -f compose.prod.yaml up -d`. Hosted chat apps also need this URL for their `/mcp` connector.