open-webui/helm-charts
1
0
Fork 0
mirror of https://github.com/open-webui/helm-charts.git synced 2026-07-22 01:45:23 -04:00
Code Issues 13 Packages Projects Releases 10 Wiki Activity

[PR #139] [MERGED] Add helm notes (Helper Message) #206

New Issue
Closed
opened 2026-02-15 19:16:51 -05:00 by yindo · 0 comments
yindo commented 2026-02-15 19:16:51 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/helm-charts/pull/139
Author: @jyje
Created: 1/14/2025
Status: ✅ Merged
Merged: 1/14/2025
Merged by: @westbrook-ai

Base: main ← Head: feat/owui-notes

📝 Commits (2)

  • 1b47d08 feat(notes): add pilot
  • 464f194 feat(notes): fix ingress and helm uninstall option

📊 Changes

2 files changed (+78 additions, -1 deletions)

View changed files

📝 charts/open-webui/Chart.yaml (+1 -1)
➕ charts/open-webui/templates/NOTES.txt (+77 -0)

📄 Description

Opinion

To resolve #66, I made pilot helm NOTES.txt for open-webui chart (as Helper Message).

Example: open-webui notes with ingress+tls

This is an example command

helm upgrade --install --cleanup-on-fail \
    -n owui-ingress --create-namespace \
    --set ingress.enabled=true \
    --set ingress.class=nginx \
    --set ingress.host=owui.example.com \
    --set ingress.tls=true \
    --set ingress.existingSecret=owui-tls \
    owui-ingress .

And this is corresponding note (helper message)

🎉 Welcome to Open WebUI!!
  ___                    __        __   _     _   _ ___ 
 / _ \ _ __   ___ _ __  \ \      / /__| |__ | | | |_ _|
| | | | '_ \ / _ \ '_ \  \ \ /\ / / _ \ '_ \| | | || | 
| |_| | |_) |  __/ | | |  \ V  V /  __/ |_) | |_| || | 
 \___/| .__/ \___|_| |_|   \_/\_/ \___|_.__/ \___/|___|
      |_|                                               

v0.5.4 - building the best open-source AI user interface.
 - Chart Version: v5.2.0
 - Project URL 1: https://www.openwebui.com/
 - Project URL 2: https://github.com/open-webui/open-webui
 - Documentation: https://docs.openwebui.com/
 - Chart URL: https://github.com/open-webui/helm-charts

Open WebUI is a web-based user interface that works with Ollama, OpenAI, Claude 3, Gemini and more.
This interface allows you to easily interact with local AI models.

1. Deployment Information:
  - Chart Name: open-webui
  - Release Name: owui-ingress
  - Namespace: owui-ingress

2. Access the Application:
  Access via ClusterIP service:

    export LOCAL_PORT=8080
    export POD_NAME=$(kubectl get pods -n owui-ingress -l "app.kubernetes.io/component=open-webui" -o jsonpath="{.items[0].metadata.name}")
    export CONTAINER_PORT=$(kubectl get pod -n owui-ingress $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
    kubectl -n owui-ingress port-forward $POD_NAME $LOCAL_PORT:$CONTAINER_PORT
    echo "Visit http://127.0.0.1:$LOCAL_PORT to use your application"

  Then, access the application at: http://127.0.0.1:$LOCAL_PORT or http://localhost:8080

  Ingress is enabled. Access the application at: https://owui.example.com

3. Useful Commands:
  - Check deployment status:
      helm status owui-ingress -n owui-ingress
  
  - Get detailed information:
      helm get all owui-ingress -n owui-ingress

  - View logs:
      kubectl logs -f statefulset/open-webui -n owui-ingress

4. Cleanup:
  - Uninstall the deployment:
      helm uninstall owui-ingress -n owui-ingress

image

Demo: open-webui notes with various settings

I recorded for 4 scenarios with following codes:

git clone -b feat/owui-notes https://github.com/jyje/owui-helm-charts
cd owui-helm-charts/charts/open-webui

kind create cluster --name owui-notes
kubectl config use-context kind-owui-notes

# 1. Install the default chart
helm upgrade --install --cleanup-on-fail \
    -n owui-default --create-namespace \
    owui-default .

# 2. Install the deploy chart
helm upgrade --install --cleanup-on-fail \
    -n owui-deploy --create-namespace \
    --set persistence.enabled=false \
    owui-deploy .

# 3. Install the nodeport chart
helm upgrade --install --cleanup-on-fail \
    -n owui-nodeport --create-namespace \
    --set service.type=NodePort \
    owui-nodeport .

# 4. Install the loadbalancer chart
helm upgrade --install --cleanup-on-fail \
    -n owui-loadbalancer --create-namespace \
    --set service.type=LoadBalancer \
    owui-loadbalancer .

Please check Demo in asciicast:
asciicast

If there are typo or good suggestion, please let me know.

Copilot Summary

This pull request includes updates to the Open WebUI Helm chart, specifically enhancing the user experience with the NOTES.txt file and updating the chart version.

Chart version update:

Enhanced user experience:

  • charts/open-webui/templates/NOTES.txt: Added a detailed welcome message and instructions for accessing and managing the Open WebUI application, including deployment information, access methods, useful commands, and cleanup instructions.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/helm-charts/pull/139 **Author:** [@jyje](https://github.com/jyje) **Created:** 1/14/2025 **Status:** ✅ Merged **Merged:** 1/14/2025 **Merged by:** [@westbrook-ai](https://github.com/westbrook-ai) **Base:** `main` ← **Head:** `feat/owui-notes` --- ### 📝 Commits (2) - [`1b47d08`](https://github.com/open-webui/helm-charts/commit/1b47d08288c92a0b5d6bd6973e823e698a96dea8) feat(notes): add pilot - [`464f194`](https://github.com/open-webui/helm-charts/commit/464f1940146b0181bc37e5b0b7a31c7d3a90aa4a) feat(notes): fix ingress and helm uninstall option ### 📊 Changes **2 files changed** (+78 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `charts/open-webui/Chart.yaml` (+1 -1) ➕ `charts/open-webui/templates/NOTES.txt` (+77 -0) </details> ### 📄 Description ## Opinion To resolve #66, I made pilot helm `NOTES.txt` for open-webui chart (as Helper Message). ### Example: open-webui notes with ingress+tls This is an example command ```sh helm upgrade --install --cleanup-on-fail \ -n owui-ingress --create-namespace \ --set ingress.enabled=true \ --set ingress.class=nginx \ --set ingress.host=owui.example.com \ --set ingress.tls=true \ --set ingress.existingSecret=owui-tls \ owui-ingress . ``` And this is corresponding note (helper message) ```sh 🎉 Welcome to Open WebUI!! ___ __ __ _ _ _ ___ / _ \ _ __ ___ _ __ \ \ / /__| |__ | | | |_ _| | | | | '_ \ / _ \ '_ \ \ \ /\ / / _ \ '_ \| | | || | | |_| | |_) | __/ | | | \ V V / __/ |_) | |_| || | \___/| .__/ \___|_| |_| \_/\_/ \___|_.__/ \___/|___| |_| v0.5.4 - building the best open-source AI user interface. - Chart Version: v5.2.0 - Project URL 1: https://www.openwebui.com/ - Project URL 2: https://github.com/open-webui/open-webui - Documentation: https://docs.openwebui.com/ - Chart URL: https://github.com/open-webui/helm-charts Open WebUI is a web-based user interface that works with Ollama, OpenAI, Claude 3, Gemini and more. This interface allows you to easily interact with local AI models. 1. Deployment Information: - Chart Name: open-webui - Release Name: owui-ingress - Namespace: owui-ingress 2. Access the Application: Access via ClusterIP service: export LOCAL_PORT=8080 export POD_NAME=$(kubectl get pods -n owui-ingress -l "app.kubernetes.io/component=open-webui" -o jsonpath="{.items[0].metadata.name}") export CONTAINER_PORT=$(kubectl get pod -n owui-ingress $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") kubectl -n owui-ingress port-forward $POD_NAME $LOCAL_PORT:$CONTAINER_PORT echo "Visit http://127.0.0.1:$LOCAL_PORT to use your application" Then, access the application at: http://127.0.0.1:$LOCAL_PORT or http://localhost:8080 Ingress is enabled. Access the application at: https://owui.example.com 3. Useful Commands: - Check deployment status: helm status owui-ingress -n owui-ingress - Get detailed information: helm get all owui-ingress -n owui-ingress - View logs: kubectl logs -f statefulset/open-webui -n owui-ingress 4. Cleanup: - Uninstall the deployment: helm uninstall owui-ingress -n owui-ingress ``` ![image](https://github.com/user-attachments/assets/75f1a608-7fb8-4fd3-a8d3-0b647abfec98) ### Demo: open-webui notes with various settings I recorded for 4 scenarios with following codes: ``` git clone -b feat/owui-notes https://github.com/jyje/owui-helm-charts cd owui-helm-charts/charts/open-webui kind create cluster --name owui-notes kubectl config use-context kind-owui-notes # 1. Install the default chart helm upgrade --install --cleanup-on-fail \ -n owui-default --create-namespace \ owui-default . # 2. Install the deploy chart helm upgrade --install --cleanup-on-fail \ -n owui-deploy --create-namespace \ --set persistence.enabled=false \ owui-deploy . # 3. Install the nodeport chart helm upgrade --install --cleanup-on-fail \ -n owui-nodeport --create-namespace \ --set service.type=NodePort \ owui-nodeport . # 4. Install the loadbalancer chart helm upgrade --install --cleanup-on-fail \ -n owui-loadbalancer --create-namespace \ --set service.type=LoadBalancer \ owui-loadbalancer . ``` Please check **Demo in asciicast**: [![asciicast](https://asciinema.org/a/698210.svg)](https://asciinema.org/a/698210) If there are typo or good suggestion, please let me know. --- ## Copilot Summary This pull request includes updates to the Open WebUI Helm chart, specifically enhancing the user experience with the NOTES.txt file and updating the chart version. ### Chart version update: * [`charts/open-webui/Chart.yaml`](diffhunk://#diff-fd1c91305ae5ec8685061c0996edf27e8fdf180534d5c02219ed03418765f624L3-R3): Updated the chart version from 5.1.1 to 5.2.0. ### Enhanced user experience: * [`charts/open-webui/templates/NOTES.txt`](diffhunk://#diff-20bc107c4eba717bf4383c76901e222ed10ff92b72db5dabdaea353ef6f5cf76R1-R80): Added a detailed welcome message and instructions for accessing and managing the Open WebUI application, including deployment information, access methods, useful commands, and cleanup instructions. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 19:16:51 -05:00
yindo closed this issue 2026-02-15 19:16:51 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
awaiting-user-feedback
awaiting-user-feedback
bug
bug
documentation
enhancement
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
upstream
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/helm-charts#206
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?