Getting started

bash cp .env.example .env docker compose up --build -d

Surface	URL
UI	http://localhost:3000
UI via Traefik	http://agentbi.localhost:8088
API	http://localhost:8000
OpenAPI docs	http://localhost:8000/docs
Traefik dashboard	http://localhost:8080

Note

Traefik listens on host port 8088 (port 80 is often already taken).

Demo login: click Sign in to demo on /login.html, or open /demo/login.html
Credentials: demo@agentbi.online / demo123 (read-only)

On first boot the API creates an admin user, a public demo user (when DEMO_USER_ENABLED=true), logs a demo API key, and (when SEED_DEMO_DATA=true or DEMO_SEED_ON_START=true) loads 6 agents plus ~30 days of events.

Health check

```bash curl -s http://localhost:8000/api/v1/health

{"status":"ok","service":"AgentBI","version":"…"}

curl -s http://localhost:8000/api/v1/health/ready

{"status":"ok","service":"AgentBI","database":true,"redis":true,"version":"…"}

curl -s http://localhost:8000/api/v1/version ```

Docs site (MkDocs)

bash pip install -r requirements-docs.txt mkdocs serve -a 127.0.0.1:8002 mkdocs build --strict # same gate as CI Docs workflow

CI workflow .github/workflows/docs.yml builds on every docs change. Publishing to GitHub Pages is optional (ENABLE_GITHUB_PAGES repo variable) — private free-tier repos cannot host Pages; download the mkdocs-site artifact instead.