You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/docs/local/helm_chart.mdx
+18-24Lines changed: 18 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,19 @@ title: 🪖 Helm Chart
3
3
description: Instructions for deploying LibreChat on Kubernetes using Helm
4
4
---
5
5
6
-
# Deployment a LibreChat Helm Chart
6
+
# Deploy a LibreChat Helm Chart
7
7
8
-
The following instructions guide you to deploy LibreChat on Kubernetes using Helm.
9
-
10
-
Note: this method was contributed by the community. If you are familiar with Helm and Kubernetes, use this guide as a reference and adjust to your needs. You can also reference other helm charts made by the community below in the [Community Helm Charts](#community-helm-charts) section.
8
+
Please follow this guidance to deploy LibreChat on Kubernetes using Helm, adjusting as needed for your specific use case. Other Helm charts contributed by the community are listed below in the [Community Helm Charts](#community-helm-charts) section.
11
9
12
10
## Prerequisites
13
11
14
12
* A running Kubernetes cluster
15
-
*`kubectl` installed
16
-
* Helm installed on your local machine
13
+
*_Local_ installations of `kubectl` and Helm
17
14
18
15
## Configuration
19
16
20
-
1. Use the [Credentials Generator](/toolkit/creds_generator) to quickly generate secure values for `CREDS_KEY`, `JWT_SECRET`, `JWT_REFRESH_SECRET` and `MEILI_MASTER_KEY`.
21
-
Place them in a Kubernetes Secret like this (If you want to change the secret name, remember to change it in your helm values):
17
+
1. Use the [Credentials Generator](/toolkit/creds_generator) to generate secure values for `CREDS_KEY`, `JWT_SECRET`, `JWT_REFRESH_SECRET` and `MEILI_MASTER_KEY`.
18
+
Place them in a Kubernetes Secret like this (if you change the secret name, remember to update your Helm values):
22
19
23
20
```yaml
24
21
apiVersion: v1
@@ -33,7 +30,7 @@ stringData:
33
30
JWT_REFRESH_SECRET: <generated value>
34
31
MEILI_MASTER_KEY: <generated value>
35
32
```
36
-
2. Depending on the provider you wanna use, add the respective credentials to the Kubernetes secret as well:
33
+
2. Add credentials for the Kubernetes Secret (dependent on the desired provider):
37
34
38
35
```yaml
39
36
apiVersion: v1
@@ -42,32 +39,29 @@ kind: Secret
42
39
43
40
OPENAI_API_KEY: <your secret value>
44
41
```
45
-
3. Apply the Secret to the Cluster
46
-
42
+
3. Apply the Secret to the Cluster:
47
43
48
44
## Install Helm Chart
49
-
In the root directory run:
45
+
In the root directory, run:
50
46
51
47
`helm install <deployment-name> helmchart`
52
48
53
-
Similar to other Helm charts, there exists a [values file](https://github.com/danny-avila/LibreChat/blob/main/helm/librechat/values.yaml) that serves two primary functions: it outlines the default settings and indicates which configurations are adjustable.
54
-
55
-
create a values.yaml file with the values you want to change in comparison to the base values
49
+
Similar to other Helm charts, there exists a [values file](https://github.com/danny-avila/LibreChat/blob/main/helm/librechat/values.yaml) that outlines the default settings and indicates which configuration options can be modified.
56
50
51
+
Create a `values.yaml` file populated with the values you want to modify from the default.
57
52
58
-
After that you can run the following command: `helm install librechat helmchart --values <values-override-filel>`
59
-
53
+
Install the Helm chart: `helm install librechat helmchart --values <values-override-filel>`
60
54
61
-
## Uninstall Helm Chart
55
+
## Uninstall the Helm Chart
62
56
63
-
In order to uninstall the Helm Chart simply run: `helm uninstall <deployment-name>`
57
+
To uninstall the Helm Chart: `helm uninstall <deployment-name>`
64
58
65
59
Example: `helm uninstall librechat`
66
60
67
61
## Migrate 1.x -> 2.x
68
-
If you used the chart before version 2.x you may have to change your value structure.
62
+
If you used the chart before version 2.x you may need to update the `value` structure.
69
63
70
-
1. Move Config to librechat.configEnv
64
+
1. Move Config to librechat.configEnv:
71
65
```diff
72
66
- env:
73
67
- ALLOW_EMAIL_LOGIN: "true"
@@ -78,9 +72,9 @@ If you used the chart before version 2.x you may have to change your value struc
78
72
+ ALLOW_EMAIL_LOGIN: "true"
79
73
```
80
74
81
-
2. Move all your secret Values to a single Secret as described [Configuration Step 1](#configuration).
82
-
3. If you still want to use an external MongoDB instance, refer to the [values file](https://github.com/danny-avila/LibreChat/blob/main/helm/librechat/values.yaml) of the Chart, deactivate the components accordingly and change the fqdn of the Mongodb Instance. This is recommended if you already have data in your externally managed mongodb instance.
75
+
2. Consolidate all Secret values to a single Secret as described in [Configuration Step 1](#configuration).
76
+
3. To leverage an external MongoDB instance, refer to the [values file](https://github.com/danny-avila/LibreChat/blob/main/helm/librechat/values.yaml) of the Chart, deactivate the components accordingly and change the FQDN of the Mongodb instance. This is recommended if data already exists in this externally managed MongoDB instance.
83
77
84
78
## Community Helm Charts
85
79
- [LibreChat Helm Chart by Blue Atlas Helm Charts](https://github.com/bat-bs/helm-charts/tree/main/charts/librechat) # will be depricated soon as its migrated here
86
-
- Example submitted by [@dimaby](https://github.com/dimaby) on GitHub: [PR #2879](https://github.com/danny-avila/LibreChat/pull/2879)
80
+
- Submitted by [@dimaby](https://github.com/dimaby) on GitHub: [PR #2879](https://github.com/danny-avila/LibreChat/pull/2879)
0 commit comments