Skip to content

deployment.md

Latest commit

 

History

History
105 lines (76 loc) · 2.92 KB

deployment.md

File metadata and controls

105 lines (76 loc) · 2.92 KB
Raw

Deployment

Otari publishes mzdotai/otari on Docker Hub. Use the Quickstart for local setup; this page covers production choices and hybrid gateways.

Standalone checklist

A durable standalone deployment should:

  • use PostgreSQL and back it up
  • set a strong master key in a secret store
  • set and back up OTARI_SECRET_KEY when storing provider credentials
  • configure explicit pricing or deliberately enable default pricing
  • terminate TLS in front of the gateway
  • restrict database and management access
  • monitor /health/readiness and, when enabled, /metrics
  • pin an image version and test migrations before upgrading

The default SQLite database is intended for evaluation and single-node local use.

Docker Compose

The repository Compose stack runs Otari and PostgreSQL:

cp config.example.yml config.yml
docker compose pull
docker compose up -d

Use docker-compose.build.yml when testing source changes:

docker compose -f docker-compose.yml -f docker-compose.build.yml up --build

Managed deployment templates

Those pages own their current image tags, variables, platform limits, and maintenance instructions.

Connect a gateway to otari.ai

Create a gateway in otari.ai and copy its gateway token, then start Otari in hybrid mode. Put the token in a private environment file:

OTARI_AI_TOKEN=gw_your_gateway_token
docker run --rm -p 8000:8000 \
  --env-file .env \
  mzdotai/otari:0.4.0 \
  otari serve

Hybrid mode does not initialize a local management database or use local provider credentials. Clients send an otari.ai user token to the gateway:

curl http://localhost:8000/v1/chat/completions \
  -H "Authorization: Bearer tk_your_user_token" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [{"role": "user", "content": "Say hello."}]
  }'

Verify both liveness and control-plane reachability:

curl http://localhost:8000/health
curl http://localhost:8000/health/readiness

See Runtime modes for the trust and credential model.

Optional services

Compose profiles start the bundled service backends:

docker compose --profile code-exec up -d
docker compose --profile web-search up -d
docker compose --profile guardrails up -d

Web search needs no container when web_search_provider names a licensed API (tavily or brave) and web_search_provider_api_key carries its key. These services are optional; requests that require an unconfigured backend fail without affecting ordinary inference.

See Built-in tools and Guardrails.

Configuration

Otari accepts a mounted YAML file, scalar environment variables, or a complete YAML document in OTARI_CONFIG_YAML or OTARI_CONFIG_B64. See Configuration for precedence and security notes.