Skip to content

Bookstack

bookstack logo

Version: 0.16.3 Type: application AppVersion: version-v24.02.3

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.22.0-0

Dependencies

Repository Name Version
https://bjw-s.github.io/helm-charts common 1.5.1
https://charts.bitnami.com/bitnami mariadb 16.0.2

Installing the Chart

To install the chart with the release name bookstack

helm install bookstack oci://ghcr.io/gabe565/charts/bookstack

Traditional

helm repo add gabe565 https://charts.gabe565.com
helm repo update
helm install bookstack gabe565/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 bjw-s 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" \
    gabe565/bookstack

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

helm install bookstack gabe565/bookstack -f values.yaml

Custom configuration

N/A

Values

Important: When deploying an application Helm chart you can add more values from the bjw-s common library chart here

Key Type Default Description
env object See values.yaml environment variables. For more options see BookStack .env.example.
image.pullPolicy string "IfNotPresent" image pull policy
image.repository string "ghcr.io/linuxserver/bookstack" image repository
image.tag string "version-v24.02.3" image tag
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.config object See values.yaml Configure persistence settings for the chart under this key.
podSecurityContext.fsGroup int 911 Volume group permissions
service object See values.yaml Configures service settings for the chart.
shelfPermissionsCron.command list See values.yaml Shelf permissions CronJob command
shelfPermissionsCron.controller.cronjob.schedule string "0 0 * * *" Shelf permissions CronJob time
shelfPermissionsCron.enabled bool false Enables a CronJob that copies shelf permissions to all child books. [ref]
shelfPermissionsCron.nameOverride string "copy-shelf-permissions" Shelf permissions CronJob name

Autogenerated from chart metadata using helm-docs