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

# Install BeyondGuard with Helm or Docker Compose

> The BeyondGuard on-premise installation process — Helm and Docker Compose options, the 16-step responsibility matrix, repository access, and air-gapped mirroring.

BeyondGuard installs on-premise via **Helm** (OpenShift/Kubernetes) or **Docker Compose** (single-node). Deployment follows a defined process with responsibilities shared between your team and BeyondGuard.

## Choose a method

<CardGroup cols={2}>
  <Card title="Helm" icon="helm">
    For OpenShift and Kubernetes. Namespace isolation, HPA auto-scaling, ConfigMap/Secret management, and Persistent Volumes.
  </Card>

  <Card title="Docker Compose" icon="docker">
    For a single node. A provided `docker-compose.yml`, volume mounts for persistence, and health-check/restart policies.
  </Card>
</CardGroup>

## Responsibility matrix

The deployment is a sequential process. Ownership is split between **you** (your infrastructure team), **BeyondGuard**, and **both** working together.

| # | Task | Owner |
| - | - | - |
| 1 | Prepare server & resources | You |
| 2 | Create image-registry user | BeyondGuard |
| 3 | Create Helm-repository user | BeyondGuard |
| 4 | Prepare network access to repositories | You |
| 5 | Prepare DNS for the application | You |
| 6 | Prepare installer & image permissions | You |
| 7 | Send artifactory IP / details | You |
| 8 | Generate company base images | BeyondGuard |
| 9 | Download images to your registry | You |
| 10 | Prepare LLM provider access | You |
| 11 | Prepare PVCs | You |
| 12 | Database connection | You |
| 13 | Get the installer (Helm chart / Compose files) | You |
| 14 | Reverse proxy settings | Both |
| 15 | Prepare installer values | Both |
| 16 | Install | Both |

## Repository access

BeyondGuard issues credentials for two repositories, in this format:

* **Helm repository** — username `helm-customer-<company>`, with an address and password provided to you.
* **Image repository** — username `docker-customer-<company>`, with an address and password provided to you.

## Install steps

<Tabs>
  <Tab title="Helm">
    1. Pull the Helm chart from the BeyondGuard repository.
    2. Edit `values.yaml` for your environment (image registry, database connections, ingress, PVC storage class, LLM provider, GPU node).
    3. Run `helm install` into your target namespace.
  </Tab>

  <Tab title="Docker Compose">
    1. Pull the Compose files from the private repository.
    2. Edit the Compose values for your environment.
    3. Run `docker compose up`.
  </Tab>
</Tabs>

## Air-gapped environments

In restricted or air-gapped networks, mirror the BeyondGuard images and Helm charts to your **internal registry or artifactory** (Harbor, Artifactory, Nexus, and similar are supported), then point the installer at your mirror. Provide your artifactory host and credentials during onboarding so the base images can be pushed there.

## Related

<CardGroup cols={2}>
  <Card title="On-Prem Requirements" icon="server" href="/deployment/on-prem-requirements">
    Prerequisites to have in place before installing.
  </Card>

  <Card title="Infrastructure Sizing" icon="gauge" href="/deployment/infrastructure-sizing">
    Size the cluster and GPU node.
  </Card>

  <Card title="ICAP & Proxy" icon="network-wired" href="/deployment/icap-proxy">
    Add inline proxy inspection.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Send your first request once installed.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.