Boemeltrein
ac3642ef74
**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._
2.3 KiB
title
| title |
|---|
| Installation Notes |
:::tip
This chart requires ingress without it you will NOT be able to access the webGUI.
:::
Prerequisite
In order to get started, plug in your UPS via USB to the server node and before modifying the UPS service section.
Go to your system shell on your node and run the following command to get the basic info for your UPS.
nut-scanner -U
My UPS uses the usbhid-ups driver from driver = "usbhid-ups".
For me though my UPS is not listed in the list, however NUT states you can use others devices of similar models from the same manufacturer as long as its uses the same driver.
You can change the Monitor User to whatever you want, I kept it default for simplicity.
I highly recommend securing the Monitor Password with a lengthy password. Special characters do work, but only tested a few.
The UPS Mode should be set to Master which means its the server and not the client.
The port or hosthame can be just left at auto.
Please set an actual shutdown command, all this will do is echo shutdown in the console.
For Auxiliary Parameters this is what I used:
LISTEN 127.0.0.1 3493
LISTEN 0.0.0.0 3493
WebNUT Deployment of the Chart
Configure via environment variables
- Set
UPS_HOSTto the local IP of your server. - Set
UPS_PORTto3493which is typically the default port. - Set
UPS_USERto the username defined for theMonitor User. - Set
UPS_PASSWORDto the password defined for theMonitor Password.
In order to access the webGUI, you will need to add ingress otherwise it will refuse to connect.
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.
:::tip
You can also reach us using Discord for real-time feedback and support If you found a bug in our chart, open a Github issue but generally it's advised to contact us on Discord first in most cases.
:::