> ## Documentation Index
> Fetch the complete documentation index at: https://hadiqio.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Deployment

> Deploy Onyx on Onyx Cloud, Docker, or Kubernetes — choose the option that fits your team's needs.

Onyx supports several deployment options, from a fully managed cloud service to self-hosted Docker and Kubernetes for teams that need full control over their infrastructure.

## Deployment options at a glance

<CardGroup cols={3}>
  <Card title="Onyx Cloud" icon="cloud">
    Managed by the Onyx team. Sign up and start immediately with no infrastructure to maintain.
  </Card>

  <Card title="Docker" icon="docker">
    Self-host on any machine with Docker. A single command gets you running.
  </Card>

  <Card title="Kubernetes / Helm" icon="server">
    Production-grade deployment for larger teams using the official Onyx Helm chart.
  </Card>
</CardGroup>

***

## Onyx Cloud

Onyx Cloud is the fully managed option. The Onyx team handles infrastructure, upgrades, and scaling.

* **14-day free trial**, no credit card required
* Business plan at \$20 per user / month (billed annually)
* Enterprise plans available with custom pricing, on-premise deployments, and region-specific hosting

To get started, sign up at [cloud.onyx.app](https://cloud.onyx.app/auth/signup).

<Note>
  Onyx Cloud uses the same codebase as the self-hosted version. Your data, chats, and connectors are portable if you decide to migrate to a self-hosted deployment.
</Note>

***

## Docker (self-hosted)

Self-hosting with Docker gives you full control over where your data lives. Onyx publishes Docker images for both Standard and Lite deployment modes.

### Onyx Lite vs Standard

Choose the mode that matches your needs:

|                                     | Onyx Lite                                        | Onyx Standard                               |
| ----------------------------------- | ------------------------------------------------ | ------------------------------------------- |
| **Memory requirement**              | Under 1 GB                                       | 16 GB recommended                           |
| **Chat and agents**                 | Yes                                              | Yes                                         |
| **RAG with hybrid search**          | No                                               | Yes                                         |
| **Connector syncing**               | No                                               | Yes                                         |
| **Code interpreter, deep research** | No                                               | Yes                                         |
| **Best for**                        | Trying Onyx or lightweight chat-only deployments | Full production use with knowledge indexing |

**Onyx Lite** is a lightweight Chat UI. It runs a smaller stack and is ideal for teams who want to evaluate Onyx quickly or only need the chat and agents capabilities.

**Onyx Standard** is the complete platform. It adds the vector and keyword index for RAG, background workers for syncing connector data, AI model inference servers, and performance components (Redis cache, MinIO blob store).

### Single-command install (recommended)

The fastest way to self-host Onyx Standard is with the guided installer:

```bash theme={null}
curl -fsSL https://onyx.app/install_onyx.sh | bash
```

The installer:

* Downloads the latest Onyx Docker images
* Creates named Docker volumes for persistent data (chats, users, indexed documents)
* Creates an `onyx_data` directory for configuration files
* Guides you through initial setup interactively

After installation, open `http://localhost` in your browser to create your admin account.

### Managing a Docker deployment

**Shut down without deleting data:**

```bash theme={null}
./install.sh --shutdown
```

**Upgrade to the latest version:**

```bash theme={null}
./install.sh --shutdown
curl -fsSL https://onyx.app/install_onyx.sh | bash
```

**Delete all data and volumes:**

```bash theme={null}
./install.sh --delete-data
```

<Warning>
  `--delete-data` permanently removes all Docker volumes including your chat history, user accounts, and indexed documents. This action cannot be undone.
</Warning>

### Manual Docker Compose

If you prefer to manage the Compose files directly, clone the repository and run Docker Compose from the `deployment/docker_compose` directory:

```bash theme={null}
docker compose up -d
```

Onyx includes several Compose configurations for different scenarios, including a Lite-mode compose file (`docker-compose.onyx-lite.yml`) for minimal deployments.

***

## Kubernetes / Helm

For production deployments at scale, Onyx provides an official Helm chart.

### Install with Helm

Add the Onyx Helm chart and install it into your cluster:

```bash theme={null}
helm install onyx . -n onyx
```

The chart deploys all Onyx components and wires them together. By default, it renders Kubernetes `HorizontalPodAutoscaler` resources for automatic scaling. You can switch to KEDA `ScaledObjects` by setting `autoscaling.engine: keda` in your `values.yaml` if you manage the KEDA operator separately.

<Tip>
  Resource requests and limits are included in the chart as initial suggestions. Tune them for your workload — the defaults may not reflect your production traffic patterns.
</Tip>

### Port-forward for local access

To access a Helm-installed Onyx instance locally:

```bash theme={null}
kubectl -n onyx port-forward service/onyx-nginx 8080:80
```

Then open `http://localhost:8080` in your browser.

***

## Cloud provider guides

Onyx can run on any infrastructure that supports Docker or Kubernetes. Deployment guides for specific cloud providers — including AWS ECS Fargate and Terraform-based setups — are available in the [full deployment documentation](https://docs.onyx.app/deployment/overview).

***

## Choosing an edition

Onyx ships in two editions regardless of deployment method:

|                                   | Community Edition (CE) | Enterprise Edition (EE) |
| --------------------------------- | ---------------------- | ----------------------- |
| **License**                       | MIT                    | Commercial              |
| **Chat, RAG, agents, connectors** | Yes                    | Yes                     |
| **Google OAuth**                  | Yes                    | Yes                     |
| **OIDC / SAML SSO**               | No                     | Yes                     |
| **SCIM provisioning**             | No                     | Yes                     |
| **White-labeling**                | No                     | Yes                     |
| **Query history and analytics**   | No                     | Yes                     |
| **Dedicated support and SLA**     | No                     | Yes                     |

Community Edition covers the full core platform and is free to use. Enterprise Edition is available on Onyx Cloud or as an on-premise license — [contact the Onyx team](https://onyx.app/contact-sales) for pricing.
