chore: Auto-update chart README [skip ci]
This commit is contained in:
parent
edec6674dc
commit
185b9cc76e
|
@ -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
|
|
@ -0,0 +1,11 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## [autobrr-0.0.1]autobrr-0.0.1 (2022-07-27)
|
||||||
|
|
||||||
|
### Feat
|
||||||
|
|
||||||
|
- Add autobrr ([#3309](https://github.com/truecharts/apps/issues/3309))
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
||||||
kubeVersion: ">=1.16.0-0"
|
kubeVersion: ">=1.16.0-0"
|
||||||
name: autobrr
|
name: autobrr
|
||||||
version: 0.0.1
|
version: 0.0.1
|
||||||
appVersion: "v1.1.0"
|
appVersion: "1.1.0"
|
||||||
description: The modern download automation tool for torrents.
|
description: The modern download automation tool for torrents.
|
||||||
type: application
|
type: application
|
||||||
deprecated: false
|
deprecated: false
|
||||||
|
|
|
@ -0,0 +1,107 @@
|
||||||
|
# autobrr
|
||||||
|
|
||||||
|
![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square)
|
||||||
|
|
||||||
|
The modern download automation tool for torrents.
|
||||||
|
|
||||||
|
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
|
||||||
|
|
||||||
|
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
|
||||||
|
For more information, please click here: [autobrr](https://truecharts.org/docs/charts/stable/autobrr)
|
||||||
|
|
||||||
|
**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)**
|
||||||
|
|
||||||
|
## Source Code
|
||||||
|
|
||||||
|
* <https://github.com/autobrr/autobrr>
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
Kubernetes: `>=1.16.0-0`
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
| Repository | Name | Version |
|
||||||
|
|------------|------|---------|
|
||||||
|
| https://library-charts.truecharts.org | common | 10.4.8 |
|
||||||
|
|
||||||
|
## Installing the Chart
|
||||||
|
|
||||||
|
### TrueNAS SCALE
|
||||||
|
|
||||||
|
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/Quick-Start%20Guides/02-Installing-an-App/).
|
||||||
|
|
||||||
|
### Helm
|
||||||
|
|
||||||
|
To install the chart with the release name `autobrr`
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm repo add TrueCharts https://helm.truecharts.org
|
||||||
|
helm repo update
|
||||||
|
helm install autobrr TrueCharts/autobrr
|
||||||
|
```
|
||||||
|
|
||||||
|
## Uninstall
|
||||||
|
|
||||||
|
### TrueNAS SCALE
|
||||||
|
|
||||||
|
**Upgrading, Rolling Back and Uninstalling the Chart**
|
||||||
|
|
||||||
|
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
|
||||||
|
|
||||||
|
### Helm
|
||||||
|
|
||||||
|
To uninstall the `autobrr` deployment
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm uninstall autobrr
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
### Helm
|
||||||
|
|
||||||
|
#### Available Settings
|
||||||
|
|
||||||
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
||||||
|
Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
||||||
|
|
||||||
|
#### Configure using the Commandline
|
||||||
|
|
||||||
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install autobrr \
|
||||||
|
--set env.TZ="America/New York" \
|
||||||
|
TrueCharts/autobrr
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Configure using a yaml file
|
||||||
|
|
||||||
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||||||
|
|
||||||
|
```console
|
||||||
|
helm install autobrr TrueCharts/autobrr -f values.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Connecting to other apps
|
||||||
|
|
||||||
|
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/docs/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ).
|
||||||
|
- See the [Website](https://truecharts.org)
|
||||||
|
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
|
||||||
|
- Open a [issue](https://github.com/truecharts/apps/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/docs/about/sponsor) or contributing back to the project any way you can!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
All Rights Reserved - The TrueCharts Project
|
Loading…
Reference in New Issue