> For the complete documentation index, see [llms.txt](https://www.health-samurai.io/docs/auditbox/llms.txt).
> Use it to discover all available pages before guessing URLs.

---
# Run Auditbox On Kubernetes

Our Helm charts streamline the deployment process, enabling easy configuration and customization while ensuring a seamless deployment experience within Kubernetes clusters. Whether you're a healthcare institution, developer, or DevOps engineer, these Helm charts provide a straightforward path to deploying Auditbox in your Kubernetes (k8s) environment.

## Elasticsearch

Auditbox uses Elasticsearch as its data storage backend. You need to have an Elasticsearch cluster running in your Kubernetes environment. You can deploy Elasticsearch using the official Elasticsearch Helm chart or any other method that suits your infrastructure.

## Auditbox

### Add auditbox helm repo

```bash
helm repo add auditbox https://aidbox.github.io/helm-charts
helm repo update
```

### Prepare Auditbox config

```yaml
image:
  repository: healthsamurai/auditbox
  tag: "alpha"

config:
  ELASTIC_URI: http://<your-elasticsearch>
  
  AUDITBOX_BASE_URL: https://<your-auditbox-host>
  AUDITBOX_API_AUTH_ENABLED: true
  AUDITBOX_LOG_LEVEL: info

  IDP_CLIENT_ID: <your-idp-client-id>
  IDP_CLIENT_SECRET: <your-idp-client-secret>

  IDP_AUTHORIZE_ENDPOINT: <your-idp-auth-url>
  IDP_TOKEN_ENDPOINT: <your-idp-token-url>
  IDP_JWKS_URI: <your-idp-jwks-url>

  BINDING: 0.0.0.0
  PORT: 3000
```

All Auditbox helm config values are [here](https://github.com/Aidbox/helm-charts/tree/main/auditbox#values).

### Apply config

```bash
helm upgrade --install auditbox auditbox/auditbox \
  --namespace auditbox --create-namespace \
  --values /path/to/auditbox-config.yaml
```

It will install the Auditbox in the `auditbox` namespace, creating that namespace if it doesn't already exist.