charts/charts/stable/bookstack
renovate[bot] 7b89f057f5
chore(deps): update helm chart common to v4.0.1 (#1204)
* chore(deps): update helm chart common to v4.0.1

* Exclude heimdall from install

It takes too long and times out the install step

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>
2021-09-15 21:51:01 +02:00
..
templates [bookstack] New chart (#817) 2021-04-22 13:23:30 -04:00
.helmignore [bookstack] New chart (#817) 2021-04-22 13:23:30 -04:00
Chart.yaml chore(deps): update helm chart common to v4.0.1 (#1204) 2021-09-15 21:51:01 +02:00
README_CHANGELOG.md.gotmpl [chart] Update Helm chart common to v4 (#1115) 2021-08-12 14:34:18 +02:00
README_CONFIG.md.gotmpl [bookstack] New chart (#817) 2021-04-22 13:23:30 -04:00
README.md Auto-generate chart README [no ci] 2021-09-01 06:01:32 +00:00
README.md.gotmpl [all] Regenerate docs 2021-06-01 12:47:34 +02:00
values.yaml [bookstack] Migrate to common v3 (#950) 2021-06-10 09:02:36 +02:00

bookstack

Version: 3.1.0 AppVersion: v21.05.1

A simple, self-hosted, easy-to-use platform for organising and storing information.

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://charts.bitnami.com/bitnami mariadb 9.4.4
https://library-charts.k8s-at-home.com common 4.0.0

TL;DR

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

Installing the Chart

To install the chart with the release name bookstack

helm install bookstack k8s-at-home/bookstack

Uninstalling the Chart

To uninstall the bookstack deployment

helm uninstall bookstack

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

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

helm install bookstack k8s-at-home/bookstack -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

Key Type Default Description
env object See below environment variables. See more environment variables in the bookstack documentation
env.TZ string "UTC" Set the container timezone
image.pullPolicy string "IfNotPresent" image tag
image.repository string "ghcr.io/linuxserver/bookstack" image repository
image.tag string "version-v21.05.1" image pull policy
ingress.main object See values.yaml Enable and configure ingress settings for the chart under this key.
mariadb object See values.yaml Enable and configure mariadb database subchart under this key. For more options see mariadb chart documentation.
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.

3.0.0

Changed

  • Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to initContainers and additionalContainers. Be sure to check out the library chart for the up-to-date values.

2.0.0

Changed

  • BREAKING: Upgraded the common library dependency to version 3.0.1. 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-v21.05.1.

1.0.0

Added

  • Initial version

Changed

  • N/A

Removed

  • N/A

Support


Autogenerated from chart metadata using helm-docs v1.5.0