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

# Lerian Console via Helm

> Helm chart installation and version compatibility reference for deploying the Lerian Console on Kubernetes, with configuration values and upgrade guidance.

Lerian Console is the unified web interface for managing Lerian products. It provides dashboards for ledger operations, account management, transaction monitoring, and plugin configuration through a single UI.

## What the chart installs

***

The chart installs one web workload: a Deployment, a Service, a ConfigMap, a Secret, and a ServiceAccount. It adds an Ingress, a HorizontalPodAutoscaler, and a PodDisruptionBudget when you enable each of them.

The chart bundles a MongoDB subchart and enables it by default. Console stores its own data there. Set `mongodb.enabled: false` to point Console at an externally managed MongoDB.

## Prerequisites

***

* A running Midaz deployment. The example service paths below assume that you install Midaz in the `midaz` namespace. If you use another namespace, override the FQDNs accordingly.
* Access Manager deployed (for authentication).
* Helm 3.8 or later for OCI registry support. Use a [currently supported Kubernetes minor release](https://kubernetes.io/releases/) in production.

## Key configuration

***

The chart ships default API paths that point at the `midaz-onboarding` and `midaz-transaction` services. The Midaz chart removed both services at v7.0.0, so you must set the paths yourself. Point them at the Ledger service:

```yaml theme={null}
configmap:
  MIDAZ_BASE_PATH: "http://midaz-ledger.midaz.svc.cluster.local:3002/v1"
  MIDAZ_TRANSACTION_BASE_PATH: "http://midaz-ledger.midaz.svc.cluster.local:3002/v1"
```

Set the credentials in the `secrets` block, or point the release at your own Secret with `useExistingSecret`. The chart ships `NEXTAUTH_SECRET`, `MONGODB_PASS`, and `PLUGIN_AUTH_CLIENT_SECRET` empty.

## Public configuration values

***

The current chart exposes these `NEXT_PUBLIC_*` values in its ConfigMap. Set them in your values file for the environment you deploy.

| Value                                             | Chart default      |
| :------------------------------------------------ | :----------------- |
| `NEXT_PUBLIC_MIDAZ_CONSOLE_AVATAR_ALLOWED_FORMAT` | `jpeg,jpg,png,svg` |
| `NEXT_PUBLIC_PLUGIN_AUTH_ENABLED`                 | `false`            |
| `NEXT_PUBLIC_MIDAZ_VERSION`                       | empty              |

## OCI registry

***

```bash theme={null}
oci://registry-1.docker.io/lerianstudio/product-console-helm
```

## Installation

***

Read the current chart version and the application version it deploys before you install:

```bash theme={null}
helm show chart oci://registry-1.docker.io/lerianstudio/product-console-helm
```

```bash theme={null}
helm install console oci://registry-1.docker.io/lerianstudio/product-console-helm --version <version> -n console --create-namespace -f my-values.yaml
```

## Upgrade and uninstall

***

```bash theme={null}
helm upgrade console oci://registry-1.docker.io/lerianstudio/product-console-helm \
  --version <new-version> -n console -f my-values.yaml
```

```bash theme={null}
helm uninstall console -n console
```

Uninstalling removes the Kubernetes resources. Check the storage settings of the bundled MongoDB subchart before you uninstall, and back up the data you want to keep.

## Resources

***

* [Lerian Console documentation](/en/platform/console/about-lerian-console)
* [Helm chart repository](https://github.com/LerianStudio/helm)