mirror of
https://github.com/open-webui/helm-charts
synced 2025-06-26 18:16:14 +00:00
82 lines
5.2 KiB
Markdown
82 lines
5.2 KiB
Markdown
# open-webui
|
|
|
|
 
|
|
|
|
Open WebUI: A User-Friendly Web Interface for Chat Interactions 👋
|
|
|
|
**Homepage:** <https://www.openwebui.com/>
|
|
|
|
## Source Code
|
|
|
|
* <https://github.com/open-webui/helm-charts>
|
|
* <https://github.com/open-webui/open-webui/pkgs/container/open-webui>
|
|
* <https://github.com/otwld/ollama-helm/>
|
|
* <https://hub.docker.com/r/ollama/ollama>
|
|
|
|
## Installing
|
|
|
|
Before you can install, you need to add the `open-webui` repo to [Helm](https://helm.sh)
|
|
|
|
```shell
|
|
helm repo add open-webui https://helm.openwebui.com/
|
|
helm repo update
|
|
```
|
|
|
|
Now you can install the chart:
|
|
|
|
```shell
|
|
helm upgrade --install open-webui open-webui/open-webui
|
|
```
|
|
|
|
## Requirements
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://helm.openwebui.com | pipelines | >=0.0.1 |
|
|
| https://otwld.github.io/ollama-helm/ | ollama | >=0.24.0 |
|
|
|
|
## Values
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| affinity | object | `{}` | Affinity for pod assignment |
|
|
| annotations | object | `{}` | |
|
|
| clusterDomain | string | `"cluster.local"` | Value of cluster domain |
|
|
| containerSecurityContext | object | `{}` | Configure container security context ref: <https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-containe> |
|
|
| extraEnvVars | list | `[{"name":"OPENAI_API_KEY","value":"0p3n-w3bu!"}]` | Additional environments variables on the output Deployment definition. Most up-to-date environment variables can be found here: https://docs.openwebui.com/getting-started/env-configuration/ |
|
|
| extraEnvVars[0] | object | `{"name":"OPENAI_API_KEY","value":"0p3n-w3bu!"}` | Default API key value for Pipelines. Should be updated in a production deployment, or be changed to the required API key if not using Pipelines |
|
|
| image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/open-webui/open-webui","tag":"latest"}` | Open WebUI image tags can be found here: https://github.com/open-webui/open-webui/pkgs/container/open-webui |
|
|
| imagePullSecrets | list | `[]` | Configure imagePullSecrets to use private registry ref: <https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry> |
|
|
| ingress.annotations | object | `{}` | Use appropriate annotations for your Ingress controller, e.g., for NGINX: nginx.ingress.kubernetes.io/rewrite-target: / |
|
|
| ingress.class | string | `""` | |
|
|
| ingress.enabled | bool | `false` | |
|
|
| ingress.existingSecret | string | `""` | |
|
|
| ingress.host | string | `""` | |
|
|
| ingress.tls | bool | `false` | |
|
|
| nameOverride | string | `""` | |
|
|
| nodeSelector | object | `{}` | Node labels for pod assignment. |
|
|
| ollama.enabled | bool | `true` | Automatically install Ollama Helm chart from https://otwld.github.io/ollama-helm/. Use [Helm Values](https://github.com/otwld/ollama-helm/#helm-values) to configure |
|
|
| ollama.fullnameOverride | string | `"open-webui-ollama"` | If enabling embedded Ollama, update fullnameOverride to your desired Ollama name value, or else it will use the default ollama.name value from the Ollama chart |
|
|
| ollamaUrls | list | `[]` | A list of Ollama API endpoints. These can be added in lieu of automatically installing the Ollama Helm chart, or in addition to it. |
|
|
| openaiBaseApiUrl | string | `""` | OpenAI base API URL to use. Defaults to the Pipelines service endpoint when Pipelines are enabled, and "https://api.openai.com/v1" if Pipelines are not enabled and this value is blank |
|
|
| persistence.accessModes | list | `["ReadWriteOnce"]` | If using multiple replicas, you must update accessModes to ReadWriteMany |
|
|
| persistence.annotations | object | `{}` | |
|
|
| persistence.enabled | bool | `true` | |
|
|
| persistence.existingClaim | string | `""` | Use existingClaim if you want to re-use an existing Open WebUI PVC instead of creating a new one |
|
|
| persistence.selector | object | `{}` | |
|
|
| persistence.size | string | `"2Gi"` | |
|
|
| persistence.storageClass | string | `""` | |
|
|
| pipelines.enabled | bool | `true` | Automatically install Pipelines chart to extend Open WebUI functionality using Pipelines: https://github.com/open-webui/pipelines |
|
|
| pipelines.extraEnvVars | list | `[]` | This section can be used to pass required environment variables to your pipelines (e.g. Langfuse hostname) |
|
|
| podAnnotations | object | `{}` | |
|
|
| podSecurityContext | object | `{}` | Configure pod security context ref: <https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-containe> |
|
|
| replicaCount | int | `1` | |
|
|
| resources | object | `{}` | |
|
|
| service | object | `{"annotations":{},"containerPort":8080,"labels":{},"loadBalancerClass":"","nodePort":"","port":80,"type":"ClusterIP"}` | Service values to expose Open WebUI pods to cluster |
|
|
| tolerations | list | `[]` | Tolerations for pod assignment |
|
|
| topologySpreadConstraints | list | `[]` | Topology Spread Constraints for pod assignment |
|
|
|
|
----------------------------------------------
|
|
|
|
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).
|