charts/charts/stable/booksonic-air/README.md
2021-06-17 22:16:41 +00:00

4.7 KiB

booksonic-air

Version: 5.2.0 AppVersion: v2009.1.0

Booksonic is a platform for accessing the audibooks you own wherever you are

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 3.2.0

TL;DR

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

Installing the Chart

To install the chart with the release name booksonic-air

helm install booksonic-air k8s-at-home/booksonic-air

Uninstalling the Chart

To uninstall the booksonic-air deployment

helm uninstall booksonic-air

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 booksonic-air \
  --set env.TZ="America/New York" \
    k8s-at-home/booksonic-air

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

helm install booksonic-air k8s-at-home/booksonic-air -f values.yaml

Custom configuration

If you plan to use networked storage to store your media or config for Booksonic, (NFS, etc.) please take a look at the Fast Access option in the Booksonic settings. This will help improve the performance of the application by not constantly monitoring media folders.

Values

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

Key Type Default Description
env.PGID string "1001" Specify the group ID the application will run as
env.PUID string "1001" Specify the user ID the application will run as
env.TZ string "UTC" Set the container timezone
image.pullPolicy string "IfNotPresent" image pull policy
image.repository string "ghcr.io/linuxserver/booksonic-air" image repository
image.tag string "version-v2009.1.0" 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.
service object See values.yaml Configures service settings for the chart.

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.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

5.0.0

Changed

  • BREAKING: Upgraded the common library dependency to version 3.0.2. This introduces several breaking changes (service, ingress and persistence keys have been refactored). Be sure to check out the library chart for the up-to-date values.
  • Changed image tag to version-v2009.1.0
  • Changed image repository to ghcr.io/linuxserver/booksonic-air

Support


Autogenerated from chart metadata using helm-docs v1.5.0