charts/charts/calibre-web

calibre-web

This is a helm chart for calibre-web utilizing the Linuxserver.io calibre-web image

TL;DR;

$ helm repo add billimek https://billimek.github.io/billimek-charts/
$ helm install billimek/calibre-web

Installing the Chart

To install the chart with the release name my-release:

helm install --name my-release billimek/calibre-web

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release --purge

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

Configuration

The following tables lists the configurable parameters of the calibre-web chart and their default values.

Parameter	Description	Default
image.repository	Image repository	linuxserver/calibre-web
image.tag	Image tag. Possible values listed here.	0.6.8-ls74
image.pullPolicy	Image pull policy	IfNotPresent
dockerMods.ebookConversion.enabled	Enable optional ebook conversion feature. (x86_64 only) refer here	false
dockerMods.ebookConversion.image.repository	DockerMod image repository	linuxserver/calibre-web
dockerMods.ebookConversion.image.tag	DockerMod image tag. These typically start with v, with the "stable" tag being calibre. Can be found here	calibre
strategyType	Specifies the strategy used to replace old Pods by new ones	Recreate
timezone	Timezone the calibre-web instance should run as, e.g. 'America/New_York'	UTC
puid	process userID the calibre-web instance should run as	1001
pgid	process groupID the calibre-web instance should run as	1001
umask	Default umask to use when creating new files	22
probes.liveness.initialDelaySeconds	Specify liveness initialDelaySeconds parameter for the deployment	60
probes.liveness.failureThreshold	Specify liveness failureThreshold parameter for the deployment	5
probes.liveness.timeoutSeconds	Specify liveness timeoutSeconds parameter for the deployment	10
probes.readiness.initialDelaySeconds	Specify readiness initialDelaySeconds parameter for the deployment	60
probes.readiness.failureThreshold	Specify readiness failureThreshold parameter for the deployment	5
probes.readiness.timeoutSeconds	Specify readiness timeoutSeconds parameter for the deployment	10
Service.type	Kubernetes service type for the calibre-web GUI	ClusterIP
Service.port	Kubernetes port where the calibre-web GUI is exposed	8083
Service.annotations	Service annotations for the calibre-web GUI	{}
Service.labels	Custom labels	{}
Service.loadBalancerIP	Loadbalance IP for the calibre-web GUI	{}
Service.loadBalancerSourceRanges	List of IP CIDRs allowed access to load balancer (if supported)	None
ingress.enabled	Enables Ingress	false
ingress.annotations	Ingress annotations	{}
ingress.labels	Custom labels	{}
ingress.path	Ingress path	/
ingress.hosts	Ingress accepted hostnames	chart-example.local
ingress.tls	Ingress TLS configuration	[]
persistence.config.enabled	Use persistent volume to store configuration data	true
persistence.config.size	Size of persistent volume claim	1Gi
persistence.config.existingClaim	Use an existing PVC to persist data	nil
persistence.config.storageClass	Type of persistent volume claim	-
persistence.config.accessMode	Persistence access mode	ReadWriteOnce
persistence.config.skipuninstall	Do not delete the pvc upon helm uninstall	false
persistence.books.enabled	Use persistent volume to store books data	true
persistence.books.size	Size of persistent volume claim	10Gi
persistence.books.existingClaim	Use an existing PVC to persist data	nil
persistence.books.storageClass	Type of persistent volume claim	-
persistence.books.accessMode	Persistence access mode	ReadWriteOnce
persistence.books.skipuninstall	Do not delete the pvc upon helm uninstall	false
persistence.extraExistingClaimMounts	Optionally add multiple existing claims	[]
resources	CPU/Memory resource requests/limits	{}
nodeSelector	Node labels for pod assignment	{}
tolerations	Toleration labels for pod assignment	[]
affinity	Affinity settings for pod assignment	{}
podAnnotations	Key-value pairs to add as pod annotations	{}
deploymentAnnotations	Key-value pairs to add as deployment annotations	{}

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

helm install --name my-release \
  --set timezone="America/New York" \
    billimek/calibre-web

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

helm install --name my-release -f values.yaml stable/calibre-web

---

NOTE

If you get Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ... it may be because you uninstalled the chart with skipuninstall enabled, you need to manually delete the pvc or use existingClaim.

---

Read through the values.yaml file. It has several commented out suggested values.