Install BookStack on Kubernetes

How to install BookStack on Kubernetes with use of Helm

BookStack Wiki software BookStack screenshot

BookStack Wiki software

11,100 GitHub stars

How to Install BookStack on Kubernetes with Helm

This guide will walk you through the process of installing BookStack using Helm, the Kubernetes package manager, ensuring a smooth and efficient setup.

Prerequisites

Before we begin, ensure you have the following tools installed and configured:

  • Kubernetes - Installed locally or in a public cloud provider
  • kubectl - Configured to communicate with your Kubernetes cluster
  • Helm - For managing Kubernetes applications like BookStack
  • Kubernetes Ingress controller - For accessing the installation on a url

Step 1: Add the Helm chart repository

First, add the repository containing the BookStack helm chart:

helm repo add stellarhosted https://stellarhosted.github.io/helm-charts
helm repo update
helm search repo bookstack

Step 2: Create a namespace (optional)

Isolating applications within Kubernetes namespaces is a good practice. To deploy BookStack in its own namespace:

kubectl create namespace bookstack

Step 3: Install Wiki.js using Helm

Now, you'll install BookStack. The helm chart name is "bookstack":

helm install bookstack stellarhosted/bookstack --namespace bookstack --create-namespace

Step 4: Verify the installation

After installation, verify that your Wiki.js deployment is running smoothly:

kubectl get pods --namespace bookstack
kubectl get all --namespace bookstack

Step 5: Customize the BookStack installation (optional)

This process may require customizing your deployment through a customized values.yaml file, which specifies configuration options.

helm install bookstack stellarhosted/bookstack --values values.yaml --namespace bookstack

Step 6: Access Wiki.js

Accessing Wiki.js will depend on your chosen service configuration (LoadBalancer, NodePort, or Ingress). For Ingress access, ensure an Ingress controller is operational in your cluster.

Follow the instructions in the helm install notes, the output of Step 3.

We can install BookStack for you

Fully managed and 14 day free trial and 100% money back guarantee

Standard

$49 / month

  • Unlimited users
  • Unlimited docs
  • 10GB storage
  • Email support
  • Custom domain with SSL
Start free trial

Premium

$99 / month

  • Unlimited users
  • Unlimited docs
  • 100GB storage
  • Priority email support
  • Custom domain with SSL
  • Single Sign-On integrations
  • Data migration
Start free trial

Custom

starts at $149 / month

  • Unlimited users
  • Unlimited docs
  • Unlimited storage
  • Live chat (Slack) support
  • Custom domain with SSL
  • Single Sign-On integrations
  • Data migration
  • High availability (SLA)
  • Special requirements
Contact us

Annual Get 2 months for free, 17% discount on a yearly plan!

We love open source

We contribute 10% of our revenue back to 56 open source projects

Directly to projects, via GitHub Sponsors and Open Collective.