hedgedoc-chart

A lightweight Helm chart for HedgeDoc that prioritizes transparency and flexibility.

Linted with kube-score, kube-linter and yamllint. Tested with helm-unittest.

Design Philosophy

No Magic

This chart may diverge from some common chart conventions. The goal is to provide a chart that is configurable and understandable. To achieve this, hidden logic and magic behavior is avoided as much as possible. But this comes at the cost of convenience: For example, if you want to change the ports the application is using, you'd have to adapt both .Values.containerPorts and whatever fields are configuring the application (environment variables at .Values.app.env or arguments at .Values.app.args, or config files at .Values.configMap.data).

No Dependencies

This chart does not bundle any databases (e.g., Postgres, Valkey) as a dependency. While this may seem inconvenient, it keeps the chart lightweight, and ensures users actively design their setup. Which database should be used? Is one already deployed? Should a new one be deployed? Is it deployed via helm chart or operator? Which helm chart should be used? Is a managed database service used? These are all questions that should be answered by the user, not the chart.

No Network Policies

This chart does not contain templates for K8s objects like NetworkPolicy. While network policies are important for securing workloads, they are highly dependent on the specific cluster setup and requirements. It's the users responsibility to define and manage network policies that fit their needs.

Getting Started

Deploy the Helm Chart

If the default values in the values.yaml fit your needs, you can deploy the helm chart using this command:

helm install hedgedoc oci://ghcr.io/ernail/charts/hedgedoc \
--namespace hedgedoc \
--create-namespace

Configure the Helm Chart

Helm provides different ways to configure helm charts via values. A common way is to create your own values file, which overrides values of the charts default values.yaml:

helm install hedgedoc oci://ghcr.io/ernail/charts/hedgedoc \
--namespace hedgedoc \
--create-namespace \
--values values-base.yaml

You can also pass in multiple values files. For example if you need seperate configuration for your dev environment:

helm install hedgedoc oci://ghcr.io/ernail/charts/hedgedoc \
--namespace hedgedoc \
--create-namespace \
--values values-base.yaml
--values values-dev.yaml

All configuration options are documented in the values.yaml. An example config is available in the values.yaml. Example deployments are available in the examples directory.

Key Configuration Options

Database

The chart does not bundle any database, so you need to provide your own database. You can configure the database connection via the app.env values. An example config is available in the values.yaml.

Image Upload

With the default configuration, HedgeDoc will use the local filesystem to store uploaded images. This behavior can be be changed via the app.env values. When doing so, you don't need the volumes and volumeMounts configured in the values.yaml.

To persist the uploaded images, persistence.enabled must be set to true.

Miscellaneous

Other important configuration options that should be reviewed are:

• app.env[].CMD_DOMAIN - The domain where HedgeDoc is reachable
• ingress - The ingress configuration for HedgeDoc
• metrics - The metrics configuration for HedgeDoc
• resources - The resource requests and limits for the HedgeDoc container
• volumeConfigs - The volume and persistence settings

Contributing

Please check the CONTRIBUTING.md to learn how to contribute.

Development

Installing dependencies

You can install all required dependencies via Task and Homebrew

brew install go-task
task install

If you'd like to use other tools, you can find all dependencies and relevant commands in the taskfile.yaml

Rendering the Helm Chart

task render

Testing the Helm Chart

task test

Running linters

task lint

Generating documentation

task docs