docs(charts): add more docs

2022-08-31 16:47:56 +02:00
parent fdfa64ea41
commit 1014b5d4fd
45 changed files with 547 additions and 0 deletions
@@ -0,0 +1,125 @@
+# 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](images/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](images/networking.png)
+
+<br />
+
+### Storage
+
+#### Configuration
+
+The setup is also default
+
+![!Storage: NZBGet](images/storage_config.png)
+
+#### Data
+
+I always mount to the root directory of the container
+
+![!Storage: NZBGet](images/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**
+
+```
+NEWPASSWORD
+```
+
+- 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.*.*`
+
+<br />
+
+### Catagories
+
+I use 5 catagories
+
+- `Movies` is used by:
+
+??? Radarr "Radarr"
+
+    - We also always enable `Remove Completed` for NZBs
+
+    ![!Settings: Radarr](images/radarr.png)
+
+- `Series` is used by:
+
+??? Sonarr "Sonarr"
+
+    - We also always enable `Remove Completed` for NZBs
+
+    ![!Settings: Sonarr](images/sonarr.png)
+
+- `Music` is used by:
+
+??? Lidarr "Lidarr"
+
+    - We also always enable `Remove Completed` for NZBs
+
+    ![!Settings: Lidarr](images/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 catagories, 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](images/catagories_files.png)
+
+<br />