migrate(qbitrr): move to stable (#12705)

**Description**
Move qbitrr to stable

⚒️ 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.

- [ ] 🪞 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._
This commit is contained in:
kqmaverick
2023-09-23 01:43:02 +03:00
committed by GitHub
parent cc3f9d663b
commit 0ba8e8b590
12 changed files with 4 additions and 4 deletions
+30
View File
@@ -0,0 +1,30 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
# OWNERS file for Kubernetes
OWNERS
# helm-docs templates
*.gotmpl
# docs folder
/docs
# icon
icon.png
View File
+30
View File
@@ -0,0 +1,30 @@
apiVersion: v2
appVersion: "3.7.4"
dependencies:
- name: common
repository: https://library-charts.truecharts.org
version: 14.0.1
deprecated: false
description: A simple script to monitor qBit and communicate with Radarr and Sonarr.
home: https://truecharts.org/charts/stable/qbitrr
icon: https://truecharts.org/img/hotlink-ok/chart-icons/qbitrr.png
keywords:
- qbitrr
- Downloaders
- MediaApp-Other
kubeVersion: ">=1.16.0-0"
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: qbitrr
sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/qbitrr
- https://github.com/Feramance/Qbitrr
type: application
version: 0.0.6
annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
- Downloaders
- MediaApp-Other
+27
View File
@@ -0,0 +1,27 @@
# README
## General Info
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/stable/qbitrr/)
**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)**
## Support
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/manual/SCALE/guides/scale-intro).
- See the [Website](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can!
*All Rights Reserved - The TrueCharts Project*
Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

@@ -0,0 +1,36 @@
# Installation Notes
This document will provide information on the successful setup of qBitrr.
## qBitrr config.toml
Upon first run qBbitrr will download a config.toml file from the upstream developer. This file is just a template and will need to be modified before qBitrr begins operating. It is recommended that when configuring initial install to also enable the codeserver addon so that you can modify the config.toml file.
## qBitrr Application Configurations
Most of the configurations can remain the default. You will need to map your qBittorrent root download directory to App Completed Download Storage as shown below.
![qbit-downloads](./img/qbit-downloads.png)
You should also enable the codeserver addon as previously discussed.
![qbitrr-codeserver](./img/qbitrr-codeserver.png)
## config.toml
Once qBitrr has started access the config.toml file using the previously configured `http://<ip address>:<port>` that was setup for the codeserver addon.
### Settings
This section has basic qBitrr settings. You may modify any as you choose but the `CompletedDownloadFolder` option must be set to `"/completed_downloads"` as that is what the App Completed Download Storage is mapped to.
:::warning Completed Download Folder
If `CompletedDownloadFolder` option is not set to `"/completed_downloads"` qBitrr will not be able to find any downloads.
:::
### qBit
This section has qBittorrent specific settings. Ensure that `Host`, `Port`, `UserName`, and `Password` all match your qBittorrent installation. The host and port can be located using the Heavyscript `heavyscript dns -a` command.
### Sonarr/Radarr
The following sections have Sonarr/Radarr specific settings. The template configuration file populates two instances for both Sonarr and Radarr by default. These can be renamed/deleted as needed to match your setup. Ensure that `URI`, `API` and `Category` are set correctly so that qBitrr can communicate with your Sonarr and Radarr installations. The `Category` is what you have set in Sonarr/Radarr to use in qBittorrent (ie. movies, tv).
### Remaining Sonarr/Radarr Configurations
All of the following sections can be configured based on personal preference. If you chose to rename or delete any of the predefined templates ensure you follow the same schema for the remaining sections. It is recommended that `SearchMissing` be set to false. qBitrr will not have access to your Sonarr/Radarr database file unless they are configured in an unsupported manner. This will disable that functionality.
Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

+67
View File
@@ -0,0 +1,67 @@
# Include{groups}
portals: {}
questions:
# Include{global}
# Include{workload}
# Include{workloadDeployment}
# Include{replicas1}
# Include{podSpec}
# Include{containerMain}
# Include{containerBasic}
# Include{containerAdvanced}
# Include{containerConfig}
# Include{podOptions}
# Include{serviceExpertRoot}
# Include{serviceExpert}
# Include{serviceList}
# Include{persistenceRoot}
- variable: config
label: App Config Storage
description: Stores the Application Configuration.
schema:
additional_attrs: true
type: dict
attrs:
# Include{persistenceBasic}
- variable: downloads
label: App Completed Downloads Storage
description: Stores the Application Completed Downloads.
schema:
additional_attrs: true
type: dict
attrs:
# Include{persistenceBasic}
# Include{persistenceList}
# Include{securityContextRoot}
- variable: runAsUser
label: "runAsUser"
description: "The UserID of the user running the application"
schema:
type: int
default: 0
- variable: runAsGroup
label: "runAsGroup"
description: "The groupID this App of the user running the application"
schema:
type: int
default: 0
# Include{securityContextContainer}
# Include{securityContextAdvanced}
# Include{securityContextPod}
- variable: fsGroup
label: "fsGroup"
description: "The group that should own ALL storage."
schema:
type: int
default: 568
# Include{resources}
# Include{advanced}
# Include{addons}
# Include{codeserver}
# Include{netshoot}
# Include{vpn}
# Include{documentation}
+1
View File
@@ -0,0 +1 @@
{{- include "tc.v1.common.lib.chart.notes" $ -}}
@@ -0,0 +1,2 @@
{{/* Render the templates */}}
{{ include "tc.v1.common.loader.all" . }}
+64
View File
@@ -0,0 +1,64 @@
image:
repository: tccr.io/truecharts/qbitrr
pullPolicy: IfNotPresent
tag: v3.7.4@sha256:46ce7db5c51415f0848963c8fa4b6afacf7ac9690ecb986449948bb455d10ecf
securityContext:
container:
readOnlyRootFilesystem: false
runAsNonRoot: false
runAsUser: 0
runAsGroup: 0
service:
main:
enabled: false
ports:
main:
enabled: false
workload:
main:
podSpec:
initContainers:
1-create-config-file:
type: install
enabled: true
imageSelector: "image"
command:
- /bin/sh
- -c
args:
- |
conf="/config/config.toml"
example="https://raw.githubusercontent.com/Feramance/qBitrr/master/config.example.toml"
if [ -f "$conf" ]; then
echo "$conf exists. Skipping..."
else
echo "$conf does not exist... Downloading the example from upstream..."
wget "$example" -O $conf || echo "Failed to download"
fi
containers:
main:
probes:
liveness:
enabled: false
readiness:
enabled: false
startup:
enabled: false
persistence:
config:
enabled: true
mountPath: /config
targetSelector:
main:
main: {}
1-create-config-file: {}
downloads:
enabled: true
mountPath: /completed_downloads
portal:
open:
enabled: false