mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-23 23:49:12 +00:00

History

k8s-at-home[bot] 2f55aac1a8 chore: Auto-update chart README [skip ci]		2022-08-02 12:19:34 +00:00
..
templates	[meta] Split incubator / stable charts (#688 )	2021-03-18 13:11:24 +01:00
.helmignore	[meta] Split incubator / stable charts (#688 )	2021-03-18 13:11:24 +01:00
Chart.yaml	chore(deps): update helm chart common to v4.5.1 (#1728 )	2022-08-02 14:18:55 +02:00
README_CONFIG.md.gotmpl	[meta] Split incubator / stable charts (#688 )	2021-03-18 13:11:24 +01:00
README.md	chore: Auto-update chart README [skip ci]	2022-08-02 12:19:34 +00:00
values.yaml	[*arr] Migrate to common v3 (#969 )	2021-06-10 14:40:31 -04:00

README.md

readarr

A fork of Radarr to work with Books & AudioBooks

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository	Name	Version
https://library-charts.k8s-at-home.com	common	4.5.1

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install readarr k8s-at-home/readarr

Installing the Chart

To install the chart with the release name readarr

helm install readarr k8s-at-home/readarr

Uninstalling the Chart

To uninstall the readarr deployment

helm uninstall readarr

The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.

Configuration

Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

helm install readarr \
  --set env.TZ="America/New York" \
    k8s-at-home/readarr

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install readarr k8s-at-home/readarr -f values.yaml

Custom configuration

Readarr is still in early development, and this chart will install a nightly build of Readarr. See the project readme for more information. Take back-up's if you decide to use this on an existing library as the project is considered unstable

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key	Type	Default	Description
env	object	See below	environment variables.
env.TZ	string	`"UTC"`	Set the container timezone
image.pullPolicy	string	`"IfNotPresent"`	image pull policy
image.repository	string	`"ghcr.io/k8s-at-home/readarr"`	image repository
image.tag	string	`"v0.1.0.715"`	image tag
ingress.main	object	See values.yaml	Enable and configure ingress settings for the chart under this key.
persistence	object	See values.yaml	Configure persistence settings for the chart under this key.
probes	object	See values.yaml	Configures the probes for the main Pod.
service	object	See values.yaml	Configures service settings for the chart.

Changelog

Version 6.4.1

Added

N/A

Changed

Upgraded common chart dependency to version 4.5.1

Fixed

N/A

Older versions

A historical overview of changes can be found on ArtifactHUB

Support

See the Docs
Open an issue
Ask a question
Join our Discord community

Autogenerated from chart metadata using helm-docs v0.1.1