This project is a complete Servarr Helm Chart that includes also Sonarr, Radarr, Prowlarr, qBitTorrent, Jellyseerr, Jellyfin and Flaresovlerr as sub-charts.
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.
- Git
- Helm
- Kuberentes Cluster (for testing purposes)
- Python 3
- Clone the repository:
$ git clone https://github.com/fonzdm/servarr.git && cd servarr- Retrieve the dependencies
$ helm dependency updateNote
If the previous command fails or goes in timeout (or takes too much), try adding the truecharts Helm repository:
$ helm repo add truecharts https://charts.truecharts.org
and then execute again the helm dependency update command.
- Prepare your
values.yaml - Try it in your cluster to check that everything is fine (replace the
servarr/with the chart folder if your workdir is different):
$ helm install servarr-dev servarr/ \
--namespace servarr-dev \
--create-namespace \
--values values.yamlTo deploy the Helm Chart:
- Add the Helm repository:
$ helm repo add fonzdm https://fonzdm.github.io/servarr- Install the release:
$ helm install <release-name> fonzdm/servarr \
--namespace servarr \
--create-namespace \
--values values.yamlIf you want to install a specific version, execute the previous command adding: --version x.y.z
Please read Helm Chart README.md for details on how to configure the values needed for this chart.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See the full list of contributors who participated in this project.
We use SemVer for versioning. For the versions available, see the releases on this repository.
Keep in mind that each dependency has its own author and their contributors. Please, reach them out on their repositories.
This project is licensed under the GNU AGPL v3 License - see the LICENSE file for details.
