docs(nzbget): helmify docs (#32837)

**Description**
<!--
helmify docs
-->
⚒️ 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._

---------

Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>
Signed-off-by: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com>
Co-authored-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>
This commit is contained in:
Boemeltrein
2025-03-04 08:06:03 +01:00
committed by GitHub
co-authored by Alfred Göppel
parent cbfa5a7363
commit b934125768
11 changed files with 13 additions and 101 deletions
+2 -1
View File
@@ -32,5 +32,6 @@ sources:
- https://ghcr.io/elfhosted/nzbget
- https://github.com/truecharts/charts/tree/master/charts/stable/nzbget
- https://nzbget.net/
- https://github.com/nzbgetcom/nzbget
type: application
version: 24.6.1
version: 24.6.2
Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

+11 -100
View File
@@ -2,118 +2,29 @@
title: Installation Guide
---
## Dataset Structure
## Persistence
This is the location your completed nzb files will be located
Add a `data` persistence for your `nzb` files. For example a mountPath `/nzb` directing to a NFS Share.
How to setup your files a good source of information is: [Trashguides](https://trash-guides.info/Downloaders/NZBGet/Basic-Setup/)
Typical setting user:group to `apps`, nothing fancy here
## Using NZBGET
- Placed the created `nzb` dataset within the `downloads` folder
### SECURITY settings
??? Note "Note"
The `apps`:`apps` user:group is built into Truenas SCALE, it is the default user for most applications on Truenas SCALE. You do not have to create a separate user for each application.
**Log-in**
When configuring your application you'll typically see user:group `568`, this is the UID for `apps` and its recommended not to change it.
For login credentials defaults:
- Username: `nzbget`
- ControlPassword: `tegbzn6789`
![!Dataset: Tube](./img/dataset.png)
<br />
## App Installation
### Networking
The setup is completely default
However, if you want to use ingress, its probably better to use clusterIP instead
![!Networking: NZBGet](./img/networking.png)
<br />
### Storage
#### Configuration
The setup is also default
![!Storage: NZBGet](./img/storage_config.png)
#### Data
I always mount to the root directory of the container
![!Storage: NZBGet](./img/storage_data.png)
Keep in mind, these are just my personal settings, if you are wanting a more in-depth example, check out [TRaSH Guides: NZBGet Documentation](https://trash-guides.info/Downloaders/NZBGet/Basic-Setup/)
<br />
### Paths
**MainDir**
`/nzb`
**ScriptDir**
`${MainDir}/scripts`
<br />
### Security
**ControlPassword**
`NEW_PASSWORD`
- set this to something you can remember
Don't forget to change them in `SECURITY` settings when you are logged in.
**AuthorizedIP**
`127.0.0.1,192.168.0.*,172.16.*.*`
- This field is separated by commas.
- We added my Lan on there `192.168.0.*`
- I added my Lan on there `192.168.0.*`
- As well as the kubernetes Network `172.16.*.*`
<br />
### Categories
I use 5 categories
- `Movies` is used by:
??? Radarr "Radarr"
- We also always enable `Remove Completed` for NZBs
![!Settings: Radarr](./img/radarr.png)
- `Series` is used by:
??? Sonarr "Sonarr"
- We also always enable `Remove Completed` for NZBs
![!Settings: Sonarr](./img/sonarr.png)
- `Music` is used by:
??? Lidarr "Lidarr"
- We also always enable `Remove Completed` for NZBs
![!Settings: Lidarr](./img/lidarr.png)
- `Manual` is ignored by all of my applications and only for my personal use
- `Manga` is for Komga
- Komga doesn't automatically import, We just decided to give it its own category anyway
While creating these categories, We _ONLY_ changed the name, no other field was changed, the files once completed, will still go into their own directory as shown below.
![!Structure: NZBGet](./img/catagories_files.png)
<br />