servarr
*arr Servarr
This project is a complete Servarr Helm Chart that includes also Sonarr, Radarr, Prowlarr, qBitTorrent, Jellyseerr, Jellyfin, Flaresolverr and Bazarr as sub-charts.
:test_tube: Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- Git
- Helm
- Kubernetes Cluster (for testing purposes)
- Python 3
Installing
- Clone the repository:
$ git clone https://github.com/datahub-local/servarr.git && cd servarr
- Retrieve the dependencies
$ helm dependency update
- Prepare your
values.yaml - Try it in your cluster to check that everything is fine (replace the
charts/servarrwith the chart folder if your workdir is different):
$ helm install servarr-dev charts/servarr \
--namespace servarr-dev \
--create-namespace \
--values values.yaml
:rocket: Deployment
To deploy the Helm Chart:
- Add the Helm repository:
$ helm repo add datahub-local https://datahub-local.github.io/servarr/
- Install the release:
$ helm install <release-name> datahub-local/servarr \
--namespace servarr \
--create-namespace \
--values values.yaml
[!WARNING]
A minimum set of values must include the various parameters with the anchor reference, otherwise the anchors won’t work as intended and the deployment may fail. Please, read the Helm Chart README.md section to see a minimal
values.yamlsample.
If you want to install a specific version, execute the previous command adding: --version x.y.z
Values
Please read the Helm Chart README.md for details on how to configure the values needed for this chart.
:memo: Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
:busts_in_silhouette: Contributors
See the full list of contributors who participated in this project.
Remember that each dependency has its own author(s) and contributors. Please contact them via their repositories.
:label: Versioning
We use SemVer for versioning. For the versions available, see the releases on this repository.
:scroll: License
This project is licensed under the GNU AGPL v3 License - see the LICENSE file for details.