From ac3642ef7467c6da2073002e7456acac7a2ce8a4 Mon Sep 17 00:00:00 2001
From: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com>
Date: Fri, 7 Mar 2025 14:33:13 +0100
Subject: [PATCH] docs(webnut): helmify docs (#32977)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

**Description**
<!--
helmify docs, the above part Prerequisite, are Truenass Screenshots, but
have nothing todo with the charts.... No idea how to change that part.
So kept as is.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [x] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
---
 .../stable/webnut/docs/installation_notes.md  | 26 +++++++++++++++----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/charts/stable/webnut/docs/installation_notes.md b/charts/stable/webnut/docs/installation_notes.md
index 6dc3128319e..45d10e21c3a 100644
--- a/charts/stable/webnut/docs/installation_notes.md
+++ b/charts/stable/webnut/docs/installation_notes.md
@@ -47,12 +47,28 @@ LISTEN 127.0.0.1 3493
 LISTEN 0.0.0.0 3493
 ```
 
-## WebNUT Installation
+## WebNUT Deployment of the Chart
 
-- Set `UPS User` to the username defined for the `Monitor User`.
-- Set `UPS Password` to the password defined for the `Monitor Password`.
-- Set `UPS Host` to the local IP of your server.
-- Set `UPS Port` to `3493` which is typically the default port.
+Configure via environment variables
+- Set `UPS_HOST` to the local IP of your server.
+- Set `UPS_PORT` to `3493` which is typically the default port.
+- Set `UPS_USER` to the username defined for the `Monitor User`.
+- Set `UPS_PASSWORD` to the password defined for the `Monitor Password`.
+
+In order to access the webGUI, you will **need** to add `ingress` otherwise it will refuse to connect.
+
+```yaml
+workload:
+  main:
+    podSpec:
+      containers:
+        main:
+          env:
+            UPS_HOST: "127.0.0.1"
+            UPS_PORT: 3493
+            UPS_USER: monuser
+            UPS_PASSWORD: secret
+```
 
 In order to access the webGUI, you will **need** to add `ingress` otherwise it will refuse to connect.