Alpha – APIs and configuration may change.

Multi-tenant terminal orchestrator for Open Terminal. Provisions isolated terminal instances per user with automatic lifecycle management.

pip install -e .
terminals serve

The server starts on http://0.0.0.0:3000. An API key is auto-generated and printed to the console.

docker build -t terminals .
docker run -p 3000:3000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v $(pwd)/data:/app/data \
  terminals

uv sync
./dev.sh  # uvicorn with --reload

Frontend (admin dashboard):

cd terminals/frontend
npm install && npm run dev

All Open Terminal endpoints are available under /terminals/. Include X-User-Id to identify the user.

export API_KEY="<api-key>"
export HEADERS=(-H "Authorization: Bearer $API_KEY" -H "X-User-Id: user-123")

curl -X POST http://localhost:3000/terminals/execute \
  "${HEADERS[@]}" -H "Content-Type: application/json" \
  -d '{"command": "echo hello"}'

curl http://localhost:3000/terminals/files/list "${HEADERS[@]}"

curl "http://localhost:3000/terminals/files/read?path=README.md" "${HEADERS[@]}"

Interactive terminal sessions connect via WebSocket at /terminals/api/terminals/{session_id}. Admins can manage tenants via /api/v1/tenants/.

Settings are loaded from environment variables prefixed with TERMINALS_ (or a .env file).

See config.py for the full list including Kubernetes, static backend, and encryption settings.

• docker – One container per user via Docker socket
• kubernetes – Pod + PVC + Service per user via K8s API
• kubernetes-operator – Delegates to a Kopf operator watching Terminal CRDs
• local – Spawns open-terminal as a subprocess (dev/testing)
• static – Proxies all users to a single pre-running instance

SQLite works out of the box. For PostgreSQL:

pip install asyncpg
export TERMINALS_DATABASE_URL=postgresql+asyncpg://user:pass@localhost:5432/terminals

Migrations run automatically on startup. Manual management:

terminals db upgrade          # run pending migrations
terminals db current          # show revision
terminals db revision -m "msg"  # create migration

Open WebUI Enterprise License