Install Docspell on Kubernetes

How to Install Docspell on Kubernetes with Helm

This guide will walk you through the process of installing Docspell 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 Docspell
• Kubernetes Ingress controller - For accessing the installation on a url

Step 1: Add the Helm chart repository

First, add the repository containing the Docspell helm chart:

helm repo add docspell https://docspell.github.io/docker
helm repo update
helm search repo docspell

Step 2: Create a namespace (optional)

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

kubectl create namespace docspell

Step 3: Install Docspell using Helm

Now, you'll install Docspell. The helm chart name is "docspell":

helm install docspell docspell/docspell --namespace docspell --create-namespace

Step 4: Verify the installation

After installation, verify that your Docspell deployment is running smoothly:

kubectl get pods --namespace docspell
kubectl get all --namespace docspell

Step 5: Customize the Docspell installation (optional)

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

helm install docspell docspell/docspell --values values.yaml --namespace docspell

Step 6: Access Docspell

Accessing Docspell 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.