Files
truecharts/charts/stable/nzbget/docs/installation.md
T
Stavros Kois 698622495c chore(docs): standardize ./img references (#16704)
**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)-->

**⚙️ 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 22:39:31 +02:00

2.5 KiB

title
title
Installation Guide

Dataset Structure

This is the location your completed nzb files will be located

Typical setting user:group to apps, nothing fancy here

  • Placed the created nzb dataset within the downloads folder

??? 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.

When configuring your application you'll typically see user:group `568`, this is the UID for `apps` and its recommended not to change it.

!Dataset: Tube


App Installation

Networking

The setup is completely default

However, if you want to use ingress, its probably better to use clusterIP instead

!Networking: NZBGet


Storage

Configuration

The setup is also default

!Storage: NZBGet

Data

I always mount to the root directory of the container

!Storage: NZBGet

Keep in mind, these are just my personal settings, if you are wanting a more in-depth example, check out TRaSH Guides: NZBGet Documentation


Paths

MainDir

/nzb

ScriptDir

${MainDir}/scripts


Security

ControlPassword

NEW_PASSWORD

  • set this to something you can remember

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.*
  • As well as the kubernetes Network 172.16.*.*

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