Guide
The Onyx Helm chart packages all required services (API, web, PostgreSQL, Redis, OpenSearch, object store, and workers) into one release. By default, the chart creates persistent volumes for the stateful services (PostgreSQL, OpenSearch, and the object store).1
Add the Onyx Helm repository
2
Install Onyx
Install into its own namespace (recommended):
3
Verify the installation
Running before you open Onyx.4
Access Onyx
By default, the chart exposes Onyx through a Kubernetes Service. For local testing, port-forward it:Then open http://localhost:8080.
5
Configure Onyx
Put your overrides in your own values file. Application settings go under Apply the file with each upgrade. Helm restarts the pods whose configuration changed.
configMap, secrets under auth.
The chart’s values.yaml
documents every key.onyx-values.yaml
Onyx Lite
Onyx Lite runs the core chat experience with only PostgreSQL. It disables the vector database, Redis, the model servers, and the background workers. Connectors and search over indexed documents are disabled. Chat, user file uploads, Projects, and Agent knowledge still work. Install with the chart’s Lite values file, then your own overrides:Production
Before you run Onyx in production, read these guides:- External Services: use managed PostgreSQL, Redis, OpenSearch, and object storage.
- High Availability and Scaling: replicas, autoscaling, probes, and long-running requests.
- Security Hardening: image pinning, credentials, security contexts, and network policies.
- Code Interpreter: restricted clusters, OpenShift, and capacity.
Enabling Onyx Craft
Craft adds per-user sandbox pods, scoped RBAC, NetworkPolicies, an egress proxy, and a Scheduled Task worker to the Helm release. Craft requires a Business or Enterprise license.Deploy Craft on Kubernetes
Prepare sandbox nodes and authentication, configure Helm, plan capacity, and verify the runtime.
Next Steps
Configure Authentication
Set up authentication for your Onyx deployment with OAuth, OIDC, or SAML.
More Onyx Configuration Options
Learn about all available configuration options for your Onyx deployment.