docs(charts): add more docs

This commit is contained in:
Kjeld Schouten-Lebbing
2022-08-31 16:47:56 +02:00
parent fdfa64ea41
commit 1014b5d4fd
45 changed files with 547 additions and 0 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

@@ -0,0 +1,96 @@
# Installation Guide
## Userdata Dataset
This is the optional location your Nextcloud userdata will be located
> You do NOT need to create a dataset if you do not plan on using one. Nextcloud does not require one, instead you can rely on the PVC default
??? 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.
- You are REQUIRED to use the `www-data` group and setting the permissions exactly, If you have anything different, chances are it will not work
- ACL's are known to cause problems with the Nextcloud Userdata folder, we advice you not to use them.
![!Dataset: Nextcloud](images/dataset.png)
## App Setup
For this application We used the `Nextcloud` provided by [TrueCharts](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/).
- Available under the `stable` train
![!Container: Tube](images/nextcloud.png)
<br />
### Container
**Application Name**
```
nextcloud
```
Name it whatever you want, We stick with the chart name for now
**NEXTCLOUD_ADMIN_USER (First Install Only)**
```
USERNAME
```
> This is up to you
<br />
**NEXTCLOUD_ADMIN_PASSWORD (First Install Only)**
```
PASSWORD
```
> This is up to you
<br />
<br />
### Storage
> This is an optional step, if you did not create a separate dataset, you can skip this
1. Ensure you are under `UserData Storage`
2. `Type of Storage` should be `Hostpath (simple)`
3. `Hostpath` should be the path to the dataset you created
![!Container: Env_Var](images/storage.png)
<br />
<br />
### Ingress
> This is another optional step, if you never plan on using ingress, you can skip this.
<br />
1. Configure Hosts > Add
2. Configure Paths > Add
3. Type your hostname under `HostName`
![!Container: Ingres](images/ingress1.png)
<br />
1. Configure TLS-Settings > Add
2. Configure Certificate Hosts > Add
3. Type your hostname under `HostName`
4. Select your correct cert
> We do not add any middlewares, since Nextcloud has its own authentication, and adding middlewares breaks phone backups, since it has no way to authenticate through Authelia
![!Container: Ingres](images/ingress2.png)
<br />
Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

+125
View File
@@ -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 />
Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

@@ -0,0 +1,164 @@
# Installation Guide
## Dataset Structure
This is the location your completed bittorrent 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
If you want to use ingress, its probably better to use `clusterIP` instead of `Simple`
![!Networking: qbittorrent](images/networking.png)
#### WebGUI
We left this default since there was no reason to change the WebGUI port
This is ALSO the port Sonarr/Radarr and other services will use to connect to qBittorrent
![!Networking: qbittorrent](images/networking_webgui.png)
#### Listening Ports
??? VPN "With VPN" - No need to port forward on your router - If you want fast seeding, you will need a service that supports port forwarding - We use Mullvad, and changed the two ports below to the port that was allocated to me by Mullvad
??? NOVPN "Without VPN" - You can leave the two ports default without a VPN - If you want fast seeding though, you will need to port forward this port on your router
![!Networking: qbittorrent](images/networking_listening.png)
<br />
### Storage
#### Configuration
The setup is default
![!Storage: NZBGet](images/storage_config.png)
#### Data
I always mount to the root directory of the container
I also try to use the applications name for the mountpath, since its typically never going to be a file or folder thats already present
![!Storage: NZBGet](images/storage_data.png)
<br />
### VPN
- Using a Wireguard setup
- Added the kubernetes network, as well as my LAN network to the killswitch
![!Storage: NZBGet](images/vpn.png)
<br />
## In-App Setup
### Downloads
??? qBittorrent "qBittorrent Table + Explanation"
| Setting | Value | Explanation |
|------------------------------------------------ |---------------------------- |---------------------------------------------------------------------------------- |
| Default Torrent Management Mode: | Automatic | This is to automatically move the files torrents based on catagory |
| When Torrent Category changed: | Relocate Torrent | This is to automatically move the files torrents based on catagory |
| When Default Save Path changed: | Relocate Affected Torrents | This is to automatically move the files torrents based on catagory |
| When Category Save Path changed: | Relocate Affected Torrents | This is to automatically move the files torrents based on catagory |
| Default Save Path: | `/qbitvpn/complete ` | Set this to what you set your dataset mountpoint as |
| Keep incomplete torrents in: | `/qbitvpn/temp` | Keep incomplete torrents in a folder no apps are monitoring |
| Copy .torrent files for finished downloads to: | `/qbitvpn/backup` | Its nice to have a backup folder of all your `.torrents` in the event of a crash |
| Monitored Folder | `/qbitvpn/monitor` | Place `.torrent` files in this directory to automatically start those torrents |
![!Downloads: qbit](images/settings_downloads.png)
<br />
### Connection
This should equal to your listening port you set [during the installation](https://heavysetup.info/applications/qbittorrent/installation/#listening-ports)
![!Connection: qbit](images/settings_connection.png)
<br />
### Speed
- Set `Alternative Rate Limits` to `10000` KiB
- This is so during the day, or when users are using my Plex server, my qBittorrent instance isn't using _ALL_ of my bandwidth seeding
- Set my schedule from `08:00` to `02:00`
- 8am to 2am, which is around the time users are watching Plex
![!Speed: qbit](images/settings_speed.png)
<br />
### BitTorrent
- Disabled `Local Peer Discovery`
- This is only useful if you are on a huge network, like a college campus or something like that
![!Speed: qbit](images/settings_bittorrent.png)
<br />
### WebGUI
- Changed the password to something We would remember
Added both my LAN and Kubernetes LAN to the bypass list, this way neither of them have to authenticate, it gets annoying to log in over and over on your own network
**Bypass authentication for clients in whitelisted IP subnets**
```
192.168.0.0/16
172.16.0.0/16
```
![!Speed: qbit](images/settings_webgui1.png)
Since We am using `Traefik`, We decided to add the Kubernetes LAN to:
**Enable reverse proxy support**
```
172.16.0.0/16
```
![!Speed: qbit](images/settings_webgui2.png)
<br />
### Advanced
??? qBittorrent "qBittorrent Table + Explanation"
| Setting | Value | Explanation |
|------------------------------------------------ |-----------------------|---------------------------------------------------------------------------------- |
| Network interface: | `wg0` or `tun0` | Bind this to `wg0` or `tun0` if you are using Wireguard (wg0) or Openvpn(tun0) |
| Optional IP address to bind to: | All Ipv4 Addresses | Kubernetes doesnt support ipv6 now anyway so, We set this to just ipv4 |
| Resolve peer countries: | True | Just so We can see what countries We am leeching/seeding from |
| Reannounce to all trackers when IP or port changed: | True | In the event my IP or port changes, We want everyone to know, so We can seed or leech |
![!Speed: qbit](images/settings_advanced.png)
<br />
Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

+162
View File
@@ -0,0 +1,162 @@
# Installation Guide
## App Installation
### Networking
If you are wanting to use ingress, its probably better to use clusterIP instead
- We changed the UDP and TCP port to match the Mullvad ports allocated, your VPN provider might require something else
![!Networking: qbittorrent](images/networking.png)
<br />
### Storage
#### Configuration
The setup is default
![!Storage: NZBGet](images/storage_config.png)
<br />
#### Media - Destination Folders
- Media is so that Radarr will have a location to place files once they're completed
- This will be the folder Radarr places files for plex to then parse through.
![!Storage: NZBGet](images/storage_data_media.png)
<br />
#### Backups
- '/config/Backups' is the location Radarr places its automatic and manual backups
- We created a separate dataset meant for backups, specifically to have an easy way to restore a backup, in the event the application is wrongly deleted, or removed, corrupt, whatever
![!Storage: NZBGet](images/storage_data_backups.png)
<br />
#### NZB
- This is obviously the location Radarr will look for completed NZB files
- Its also the location NZBGet saves its completed movie files
![!Storage: NZBGet](images/storage_data_nzb.png)
<br />
#### Bittorrent
- This is the location Radarr will look for completed qBittorrent files
- Its also the location qBittorrent saves its completed movie files
![!Storage: NZBGet](images/storage_data_qbit.png)
<br />
#### Syncthing
- This is the location Radarr will look for completed Syncthing files
- Its also the location Syncthing saves its completed movie files
![!Storage: NZBGet](images/storage_data_syncthing.png)
<br />
## In-App Configuration
For Radarr, We specifically just follow the [TRaSH Guides for Radarr](https://trash-guides.info/Radarr/) setup.
- It clearly details how to setup custom profiles to ensure you are grabbing the latest and greatest media. We have been using it for months now and have not had an issue.
<br />
Thank Goodness for IBRACORP, We thought We would have to make a video myself covering this topic. However, it seems they got most of everything We would have covered.
![type:video](https://www.youtube.com/embed/DCxU3Vzaz6k)
## qbittorrent Integration
### Mountpoints
Its important to keep your mountpoints for each of the applications the same. Otherwise you will need to setup a `remote path`
- They may be slightly different, but as long as they have the same root directory it will be fine.
<br />
#### Radarrs Storage Settings
I set it to a sub directory of `/qbitvpn` though since `/qbitvpn/complete/movies` is the only directory Radarr needs to see, since it only needs to see movies that are completed
![!Storage: NZBGet](images/qbit_radarr_storage.png)
#### qBittorrents Storage Settings
![!Storage: NZBGet](images/qbit_storage.png)
<br />
### Linking Radarr to qBittorrent
![!Storage: NZBGet](images/qbit_radarr_client.png)
#### Explanation
??? Radarr "Explanation"
| Name | Value | Reason |
|------------------ |-------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | qbitvpn | Doesn't matter what you call it, just call it something memorable |
| Host | qbitvpn-qbittorrent.ix-qbitvpn.svc.cluster.local | You will need to generate a different DNS name if your app name is not `qbitvpn` Generate a new name with [ Truecharts Guide ]( https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/ ) |
| Port | 10095 | This is the default port, but if you changed it then its [ the first port listed under networking for qbittorrent ](https://heavysetup.info/applications/qbittorrent/installation/#networking ) |
| Username | NULL | You can leave this empty if you followed [WEBGUI guide](https://heavysetup.info/applications/qbittorrent/in-app/#webgui ) |
| Password | NULL | You can leave this empty if you followed [WEBGUI guide](https://heavysetup.info/applications/qbittorrent/in-app/#webgui ) |
| Category | movies | We want my completed torrents to be moved to a folder in `completed/movies` once their done |
| Remove Completed | False | We do not want to delete my torrents before their done seeding |
<br />
## NZBGet Integration
### Mountpoints
Its important to keep your mountpoints for each of the applications the same. Otherwise you will need to setup a `remote path`
- They may be slightly different, but as long as they have the same root directory it will be fine.
<br />
#### Radarrs Storage Settings
![!Storage: NZBGet](images/nzbget_radarr_storage.png)
#### NZBGet Storage Settings
![!Storage: NZBGet](images/nzbget_storage.png)
<br />
### Linking Radarr to NZBGet
![!Storage: NZBGet](images/nzbget_radarr_client.png)
#### Explanation
??? Radarr "Explanation"
| Name | Value | Reason |
|------------------ |------------------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name | NZBGet | Doesn't matter what you call it, just call it something memorable |
| Host | nzbget.ix-nzbget.svc.cluster.local | You will need to generate a different DNS name if your app name is not `nzbget` Generate a new name with [ Truecharts Guide ]( https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/ ) |
| Port | 6789 | This is the default port, but if you changed it then its [ the only port listed under networking for NZBGet ](https://heavysetup.info/applications/nzbget/installation/#networking ) |
| Username | nzbget | Default is `nzbget` but its under your security settings in nzbget |
| Password | NULL | This is whatever you set during the [NZBGet in app security](https://heavysetup.info/applications/nzbget/in-app/#security ) setup |
| Category | Movies | We want my completed nzbs to be moved to a folder in `completed/Movies` once their done |
| Remove Completed | True | You can't seed nzbs, so there's no point in keeping them |
| Remove Failed | True | No reason to keep failed articles |
<br />