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.
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. Production startup requires JWT_VERIFICATION_KEY or a readable JWKS file at the container path in JWT_JWKS_FILE; otherwise the process exits.
Token-Based Auth gives you three things:
- Protected runtime access. Protected API routes require a valid credential. Health, discovery, and API documentation remain public; Slack and MCP OAuth have their own authentication flows.
- Per-request identity. Middleware validates the token and exposes its
user_id, optionalsession_id, scopes, and claims to the request. - Scope-based permissions. Token scopes control access to AgentOS routes and resources.
The template already sets AuthorizationConfig(user_isolation=True). Authenticated non-admin REST access is scoped to the principal; local dev mode disables scope enforcement and is open when no credentials are configured. This does not scope Platform Manager’s direct database tools to that REST identity. See User Isolation for the boundaries and admin exceptions.
To disable JWT authentication in a private deployment with another auth layer, set authorization=False, remove JWT_VERIFICATION_KEY and JWT_JWKS_FILE from the running service, and rebuild or redeploy the app as needed. Disabling scope enforcement alone does not remove JWT validation while those credentials remain configured. MCP OAuth remains enabled while MCP_CONNECT_SECRET is set.
Customize
Ask your coding agent to run /create-agent, or do it by hand. Create agents/my_agent.py:
from agno.agent import Agent
from app.learning import shared_learning
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",
user_id="anonymous-user", # Local fallback; authenticated runs supply identity.
model=default_model(),
db=get_postgres_db(),
instructions=INSTRUCTIONS,
learning=shared_learning,
add_datetime_to_context=True,
add_history_to_context=True,
num_history_runs=5,
)The fallback user ID lets local anonymous calls use the shared learning machine; those calls share one profile. Authenticated run identity overrides this default.
Import it in app/main.py and update the agents argument in the existing AgentOS call. Keep its other arguments, including teams, workflows, knowledge, and registry:
from agents.my_agent import my_agent
agent_os = AgentOS(
# Keep the other arguments from the existing call.
agents=[platform_builder, platform_manager, platform_engineer, my_agent],
)Add its UI metadata beneath the existing manifest: key in app/config.yaml:
my-agent:
description: "What the agent does."
quick_prompts:
- "First example prompt"
- "Second example prompt"
- "Third example prompt"Local containers reload Python source changes. After editing app/config.yaml, run docker compose restart agentos-api to reload the manifest. 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:
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:
./scripts/generate_requirements.shRebuild locally with docker compose up -d --build. For production:
docker compose -f compose.yaml -f compose.prod.yaml up -d --buildAgno ships 100+ toolkits. See Toolkits.
from agno.tools.slack import SlackTools
my_agent = Agent(
# Keep the agent’s existing configuration.
tools=[SlackTools()],
)- Edit
pyproject.toml. - Regenerate pins:
./scripts/generate_requirements.sh(addupgradeto refresh every pin). - Rebuild locally with
docker compose up -d --build, or in production withdocker compose -f compose.yaml -f compose.prod.yaml up -d --build.
Set both variables in .env:
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 the Agno team. Change team= in app/main.py to select another team, or replace it with agent=my_agent to route to an agent. See Slack setup.
The deployment check runs daily by default (ENABLE_DEPLOY_CHECK=True); it uses fixed checks without model calls. The run-evals schedule is always registered but starts disabled because it uses model calls. Enable it from the AgentOS UI. Both workflows remain runnable on demand. Startup reapplies ENABLE_DEPLOY_CHECK to the deployment-check schedule; the enabled state of an existing run-evals schedule is preserved.
Format, validate, and run evals
Run evals against a dedicated local test platform with no concurrent writers. The starter’s cleanup hooks remove components and learning state created during a case; concurrent application writes can be removed too. The same prerequisite applies to scheduled evals. See eval setup and isolation.
The host scripts require uv. The setup script creates a Python 3.14 venv:
./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 scope enforcement; configured JWT credentials still enable token validation. compose.yaml sets dev for local; compose.prod.yaml sets prd. Keep production on prd so scope enforcement remains enabled. |
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 inside the container to a JWKS file. Production Compose does not mount this file. Add a read-only bind mount, or bake the file into the image and rebuild. |
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. When MCP_CONNECT_SECRET is set, OAuth metadata also derives its public origin from this URL. |
ENABLE_DEPLOY_CHECK | No | True | Daily deployment-check cron. |
EVALS_TAG | No | smoke | Eval tag the run-evals workflow runs. |
EVALS_CASE_TIMEOUT_SECONDS | No | 90 | Fallback timeout for cases without an explicit timeout. |
EVALS_SUITE_TIMEOUT_SECONDS | No | derived from selected cases | Sum of selected case timeouts plus 30 seconds per case, with a 60-second floor. A positive integer overrides this ceiling. |
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.
Non-dev mode requires JWT verification configuration. Configured JWT credentials also enable validation in dev mode. Set JWT_VERIFICATION_KEY in .env and recreate the container. For JWT_JWKS_FILE, first add a read-only production bind mount and point the variable at its container path, or bake the file into the image and recreate with --build. For a private deployment using another auth layer, follow the credential-removal steps under Production auth.
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:
docker compose exec agentos-db psql -U ai -c "ALTER USER ai WITH PASSWORD '<new>';"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.