Skip to content

Commit

Permalink
feat(peanut) move peanut to stable (#18746)
Browse files Browse the repository at this point in the history
**Description**
Moves peanut to stable and adds installation notes.

⚒️ Fixes  # 

**⚙️ Type of change**

- [X] ⚙️ 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?**

**📃 Notes:**

**✔️ 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
- [X] ⬆️ 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.

- [X] 🖼️ 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._
  • Loading branch information
kqmaverick authored Mar 3, 2024
1 parent a427239 commit fa4b7d8
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 8 deletions.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ annotations:
truecharts.org/category: system
truecharts.org/max_helm_version: "3.14"
truecharts.org/min_helm_version: "3.11"
truecharts.org/train: incubator
truecharts.org/train: stable
apiVersion: v2
appVersion: 2.5.0
dependencies:
Expand All @@ -18,7 +18,7 @@ dependencies:
import-values: []
deprecated: false
description: A Tiny Dashboard for Network UPS Tools.
home: https://truecharts.org/charts/incubator/peanut
home: https://truecharts.org/charts/stable/peanut
icon: https://truecharts.org/img/hotlink-ok/chart-icons/peanut.png
keywords:
- peanut
Expand All @@ -31,7 +31,7 @@ maintainers:
name: peanut
sources:
- https://github.com/Brandawg93/PeaNUT
- https://github.com/truecharts/charts/tree/master/charts/incubator/peanut
- https://github.com/truecharts/charts/tree/master/charts/stable/peanut
- https://hub.docker.com/r/brandawg93/peanut
type: application
version: 0.0.1
version: 1.0.0
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: README
TrueCharts can be installed as both _normal_ Helm Charts or as Apps on TrueNAS SCALE.
However only installations using the TrueNAS SCALE Apps system are supported.

For more information about this App, please check the docs on the TrueCharts [website](https://truecharts.org/charts/incubator/peanut)
For more information about this App, please check the docs on the TrueCharts [website](https://truecharts.org/charts/stable/peanut)

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**

Expand Down
14 changes: 14 additions & 0 deletions charts/stable/peanut/docs/installation-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Installation Notes

Notes about the proper setup of PeaNUT.

## Configuration

- NUT Host: This is the server that NUT is running on. On TrueNAS Scale this would be your Scale IP Address.
- NUT Port: This is the port that the NUT is running on. On TrueNAS Scale this is `3493`
- Username: This is the username of the NUT. On TrueNAS Scale this is set in the UPS Service as `Monitor User` the default is `upsmon`
- Password: This is the password of the NUT. On TrueNAS Scale this is set in the UPS Service as `Monitor Password`

## Homepage Widget

- PeaNUT supports Homepage integration and has a Widget. After enabling Homepage and the Widget enter the name of the UPS in the `API-key (key)` block. On TrueNAS Scale this is set in the UPS Service as `Identifier`.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ questions:
type: dict
attrs:
- variable: NUT_HOST
label: Nut Host
label: NUT Host
description: Host of NUT server
schema:
type: string
default: "localhost"
- variable: NUT_PORT
label: Nut Port
label: NUT Port
description: Port of NUT server
schema:
type: int
default: 3493
- variable: USERNAME
label: UserName
label: Username
schema:
type: string
default: ""
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit fa4b7d8

Please sign in to comment.