TrueChartsClone/charts/stable/webnut/docs/installation_notes.md

65 lines
1.9 KiB
Markdown
Raw Normal View History

chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ 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 **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 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 **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ 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._
2023-12-31 14:24:05 +00:00
---
title: Installation Notes
---
2022-10-25 23:19:50 +00:00
:::tip
2022-10-25 23:19:50 +00:00
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.
2024-04-13 23:48:36 +00:00
```shell
2022-10-25 23:19:50 +00:00
nut-scanner -U
```
![nut-scanner](./img/nut-scanner.png)
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.
![ups-server](./img/ups-server.png)
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`.
![ups-shutdown](./img/ups-shutdown.png)
Please set an actual shutdown command, all this will do is echo `shutdown` in the console.
![ups-other](./img/ups-other.png)
For `Auxiliary Parameters` this is what I used:
```text
LISTEN 127.0.0.1 3493
LISTEN 0.0.0.0 3493
```
## WebNUT Installation
- 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.
In order to access the webGUI, you will **need** to add `ingress` otherwise it will refuse to connect.
:::tip
2022-10-25 23:19:50 +00:00
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.
:::