charts/charts/stable/nzbget/README.md

127 lines
4.0 KiB
Markdown
Raw Normal View History

2021-02-17 22:43:56 +00:00
# nzbget
![Version: 9.2.0](https://img.shields.io/badge/Version-9.2.0-informational?style=flat-square) ![AppVersion: v21.0](https://img.shields.io/badge/AppVersion-v21.0-informational?style=flat-square)
2021-02-17 22:43:56 +00:00
NZBGet is a Usenet downloader client
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
2021-02-18 18:19:14 +00:00
## Source Code
* <https://hub.docker.com/r/linuxserver/nzbget/>
* <https://nzbget.net/>
2021-02-17 22:43:56 +00:00
## Requirements
2021-02-17 22:43:56 +00:00
Kubernetes: `>=1.16.0-0`
2021-02-17 22:43:56 +00:00
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 2.2.0 |
2021-02-17 22:43:56 +00:00
## TL;DR
```console
2021-02-17 22:43:56 +00:00
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install nzbget k8s-at-home/nzbget
```
2021-02-17 22:43:56 +00:00
## Installing the Chart
2021-02-17 22:43:56 +00:00
To install the chart with the release name `nzbget`
```console
helm install nzbget k8s-at-home/nzbget
```
## Uninstalling the Chart
2021-02-17 22:43:56 +00:00
To uninstall the `nzbget` deployment
```console
2021-02-17 22:43:56 +00:00
helm uninstall nzbget
```
2021-02-17 22:43:56 +00:00
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
## Configuration
2021-02-17 22:43:56 +00:00
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/k8s-at-home/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).
2021-02-17 22:43:56 +00:00
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install nzbget \
2021-02-17 22:43:56 +00:00
--set env.TZ="America/New York" \
k8s-at-home/nzbget
```
2021-02-17 22:43:56 +00:00
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
2021-02-17 22:43:56 +00:00
helm install nzbget k8s-at-home/nzbget -f values.yaml
```
2021-02-17 22:43:56 +00:00
## Custom configuration
2021-02-17 22:43:56 +00:00
The default login details (change ASAP) are:
2021-02-17 22:43:56 +00:00
* login:nzbget
* password:tegbzn6789
## Values
2021-03-16 16:48:18 +00:00
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
2021-02-17 22:43:56 +00:00
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"linuxserver/nzbget"` | |
| image.tag | string | `"version-v21.0"` | |
| ingress.enabled | bool | `false` | |
| persistence.config.emptyDir.enabled | bool | `false` | |
2021-02-17 22:43:56 +00:00
| persistence.config.enabled | bool | `false` | |
| persistence.downloads.emptyDir.enabled | bool | `false` | |
2021-02-17 22:43:56 +00:00
| persistence.downloads.enabled | bool | `false` | |
| persistence.downloads.mountPath | string | `"/downloads"` | |
| persistence.media.emptyDir.enabled | bool | `false` | |
2021-02-17 22:43:56 +00:00
| persistence.media.enabled | bool | `false` | |
| persistence.media.mountPath | string | `"/media"` | |
| service.port.port | int | `6789` | |
| strategy.type | string | `"Recreate"` | |
## Changelog
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
2021-02-17 22:43:56 +00:00
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### [1.0.0]
#### Added
- N/A
2021-02-17 22:43:56 +00:00
#### Changed
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
- N/A
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
#### Removed
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
- N/A
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
[1.0.0]: #1.0.0
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
## Support
2020-11-09 13:19:21 +00:00
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
2021-02-17 22:43:56 +00:00
- Join our [Discord](https://discord.gg/sTMX7Vh) community
2020-11-09 13:19:21 +00:00
2021-02-17 22:43:56 +00:00
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)