Deployment Guide | PraisonAIUI Docs

Deployment GuideProduction deployment guide for AIUI — covering Docker, environment variables, configuration, and security.Quick Start (Docker)Build the ImageRun with Default SettingsRun with Custom Data DirectoryDocker Compose ExampleEnvironment Variables| Variable | Default | Description ||----------|---------|-------------|| AIUI_DATA_DIR | ~/.praisonaiui | Data directory for config, sessions, logs || AIUI_PORT | 8082 | Server port (Docker only) || AIUI_HOST | 0.0.0.0 | Server bind address (Docker only) || AUTH_ENFORCE | false | Enforce Bearer token auth on /api/* routes || OPENAI_API_KEY | — | OpenAI API key for LLM provider |Auth EnforcementWhen AUTH_ENFORCE=true, all /api/* routes require a valid Bearer token in the Authorization header:Exempt paths (always accessible without auth):/health, /health/live, /health/ready, /api/health — health checks/api/auth/login, /login — login endpoints/api/protocol, /api/protocol/negotiate — protocol discoveryConfigurationConfig File LocationThe config file is located at AIUI_DATA_DIR/config.yaml (default: ~/.praisonaiui/config.yaml).Config StructureSite Title CustomizationThe site title is configurable via site.title in config.yaml:This affects:HTML <title> tagDashboard header/ui-config.json responseHealth MonitoringHealth EndpointKubernetes ProbesUse the fast liveness endpoint for probes to avoid timeouts:Docker HEALTHCHECKThe Dockerfile includes a built-in health check:CLI Health CommandsSecurityAuth ModesAIUI supports multiple authentication modes:| Mode | Description ||------|-------------|| none | No authentication (default) || api_key | API key in X-API-Key header or api_key query param || session | Session token in Authorization: Bearer <token> header || password | Username/password login |API Key ManagementNetwork ConsiderationsInternal networks: Use AUTH_ENFORCE=false if behind a trusted reverse proxyPublic exposure: Always set AUTH_ENFORCE=true and use HTTPSLoad balancers: Health check path is /health/live (fast, exempt from auth)Managed HostingRequired EndpointsHosting platforms should expose these endpoints:| Endpoint | Purpose ||----------|---------|| /health/live | Fast liveness probe (returns {"status": "ok"}) || /health/ready | Readiness probe (parallel feature checks) || /health | Deep health (parallel feature checks; ?deep=false for liveness) || /api/protocol | Protocol version and capabilities || /api/protocol/negotiate | Capability negotiation || /api/features | List of registered features |Protocol DiscoveryMinimum Viable DeploymentFor a minimal AIUI deployment:1. Required: OPENAI_API_KEY environment variable2. Recommended: Persistent volume for AIUI_DATA_DIR3. Optional: AUTH_ENFORCE=true for multi-tenant environments