mirror of
https://github.com/k8s-at-home/charts.git
synced 2025-01-31 13:59:04 +00:00
114 lines
4.6 KiB
Markdown
114 lines
4.6 KiB
Markdown
# calibre-web
|
|
|
|
 
|
|
|
|
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database.
|
|
|
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
|
|
|
|
## Source Code
|
|
|
|
* <https://hub.docker.com/r/linuxserver/calibre-web/>
|
|
* <https://github.com/janeczku/calibre-web>
|
|
|
|
## Requirements
|
|
|
|
Kubernetes: `>=1.16.0-0`
|
|
|
|
## Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| https://library-charts.k8s-at-home.com | common | 3.2.0 |
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
helm repo add k8s-at-home https://k8s-at-home.com/charts/
|
|
helm repo update
|
|
helm install calibre-web k8s-at-home/calibre-web
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `calibre-web`
|
|
|
|
```console
|
|
helm install calibre-web k8s-at-home/calibre-web
|
|
```
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall the `calibre-web` deployment
|
|
|
|
```console
|
|
helm uninstall calibre-web
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
|
|
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
|
|
```console
|
|
helm install calibre-web \
|
|
--set env.TZ="America/New York" \
|
|
k8s-at-home/calibre-web
|
|
```
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
|
|
```console
|
|
helm install calibre-web k8s-at-home/calibre-web -f values.yaml
|
|
```
|
|
|
|
## Custom configuration
|
|
|
|
N/A
|
|
|
|
## Values
|
|
|
|
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
|
|
|
|
| Key | Type | Default | Description |
|
|
|-----|------|---------|-------------|
|
|
| env | object | See below | environment variables. See more environment variables in the [calibre-web documentation](https://github.com/linuxserver/docker-calibre-web#parameters). |
|
|
| 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 | `"linuxserver/calibre-web"` | image repository |
|
|
| image.tag | string | `"version-0.6.12"` | 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](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
### [7.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](https://github.com/k8s-at-home/library-charts/blob/common-3.0.2/charts/stable/common/) for the up-to-date values.
|
|
- Changed image tag to `version-0.6.12`.
|
|
|
|
[7.0.0]: #700
|
|
|
|
## Support
|
|
|
|
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
|
|
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
|
|
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
|
|
- Join our [Discord](https://discord.gg/sTMX7Vh) community
|
|
|
|
----------------------------------------------
|
|
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
|