# DokuWiki

[DokuWiki](https://www.dokuwiki.org) is a standards-compliant, simple to use wiki optimized for creating documentation. It is targeted at developer teams, workgroups, and small companies. All data is stored in plain text files, so no database is required.

## TL;DR

```console
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/dokuwiki
```

## Introduction

This chart bootstraps a [DokuWiki](https://github.com/bitnami/bitnami-docker-dokuwiki) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

Bitnami charts can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the [BKPR](https://kubeprod.io/).

## Prerequisites

- Kubernetes 1.12+
- Helm 3.0-beta3+
- PV provisioner support in the underlying infrastructure
- ReadWriteMany volumes for deployment scaling

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm install my-release bitnami/dokuwiki
```

The command deploys DokuWiki on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.

> **Tip**: List all releases using `helm list`

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```console
$ helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Parameters

The following table lists the configurable parameters of the DokuWiki chart and their default values per section/component:

### Global parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `global.imageRegistry`                               | Global Docker image registry                                                                                                                              | `nil`                                                        |
| `global.imagePullSecrets`                            | Global Docker registry secret names as an array                                                                                                           | `[]` (does not add image pull secrets to deployed pods)      |
| `global.storageClass`                                | Global storage class for dynamic provisioning                                                                                                             | `nil`                                                        |

### Common parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `commonAnnotations`                                  | Annotations to add to all deployed objects                                                                                                                | `[]`                                                         |
| `commonLabels`                                       | Labels to add to all deployed objects                                                                                                                     | `nil`                                                        |
| `extraDeploy`                                        | Array of extra objects to deploy with the release (evaluated as a template).                                                                              | `nil`                                                        |
| `fullnameOverride`                                   | String to fully override dokuwiki.fullname template with a string                                                                                         | `nil`                                                        |
| `image.pullPolicy`                                   | Image pull policy                                                                                                                                         | `Always`                                                     |
| `image.pullSecrets`                                  | Specify docker-registry secret names as an array                                                                                                          | `[]` (does not add image pull secrets to deployed pods)      |
| `image.registry`                                     | DokuWiki image registry                                                                                                                                   | `docker.io`                                                  |
| `image.repository`                                   | DokuWiki image name                                                                                                                                       | `bitnami/dokuwiki`                                           |
| `image.tag`                                          | DokuWiki image tag                                                                                                                                        | `{TAG_NAME}`                                                 |
| `image.debug`                                        | Enable image debugging                                                                                                                                    | `false`                                                      |
| `nameOverride`                                       | String to partially override dokuwiki.fullname template with a string (will prepend the release name)                                                     | `nil`                                                        |

### Dokuwiki parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `dokuwikiUsername`                                   | User of the application                                                                                                                                   | `user`                                                       |
| `dokuwikiFullName`                                   | User's full name                                                                                                                                          | `User Name`                                                  |
| `dokuwikiPassword`                                   | Application password                                                                                                                                      | _random 10 character alphanumeric string_                    |
| `dokuwikiEmail`                                      | User email                                                                                                                                                | `user@example.com`                                           |
| `dokuwikiWikiName`                                   | Wiki name                                                                                                                                                 | `My Wiki`                                                    |
| `args`                                               | Override default container args (useful when using custom images)                                                                                         | `nil`                                                        |
| `command`                                            | Override default container command (useful when using custom images)                                                                                      | `nil`                                                        |
| `existingSecret`                                     | Name of a secret with the application password                                                                                                            | `nil`                                                        |
| `podLabels`                                          | Add additional labels to the pod (evaluated as a template)                                                                                                | `nil`                                                        |
| `sidecars`                                           | Attach additional containers to the pod (evaluated as a template)                                                                                         | `nil`                                                        |
| `podSecurityContext.enabled`                         | Enable securityContext on for DokuWiki deployment                                                                                                         | `true`                                                       |
| `podSecurityContext.fsGroup`                         | Group to configure permissions for volumes                                                                                                                | `1001`                                                       |
| `containerSecurityContext.enabled`                   | Enable securityContext on for DokuWiki deployment                                                                                                         | `true`                                                       |
| `containerSecurityContext.runAsUser`                 | User for the securityContext                                                                                                                              | `1001`                                                       |
| `persistence.enabled`                                | Enable persistence using PVC                                                                                                                              | `true`                                                       |
| `persistence.storageClass`                           | PVC Storage Class for DokuWiki volume                                                                                                                     | `nil` (uses alpha storage class annotation)                  |
| `persistence.accessMode`                             | PVC Access Mode for DokuWiki volume                                                                                                                       | `ReadWriteOnce`                                              |
| `persistence.size`                                   | PVC Storage Request for DokuWiki volume                                                                                                                   | `8Gi`                                                        |
| `resources`                                          | CPU/Memory resource requests/limits                                                                                                                       | Memory: `512Mi`, CPU: `300m`                                 |
| `livenessProbe.enabled`                              | Enable/disable the liveness probe                                                                                                                         | `true`                                                       |
| `livenessProbe.initialDelaySeconds`                  | Delay before liveness probe is initiated                                                                                                                  | 120                                                          |
| `livenessProbe.periodSeconds`                        | How often to perform the probe                                                                                                                            | 10                                                           |
| `livenessProbe.timeoutSeconds`                       | When the probe times out                                                                                                                                  | 5                                                            |
| `livenessProbe.failureThreshold`                     | Minimum consecutive failures to be considered failed                                                                                                      | 6                                                            |
| `livenessProbe.successThreshold`                     | Minimum consecutive successes to be considered successful                                                                                                 | 1                                                            |
| `readinessProbe.enabled`                             | Enable/disable the readiness probe                                                                                                                        | `true`                                                       |
| `readinessProbe.initialDelaySeconds`                 | Delay before readinessProbe is initiated                                                                                                                  | 30                                                           |
| `readinessProbe.periodSeconds   `                    | How often to perform the probe                                                                                                                            | 10                                                           |
| `readinessProbe.timeoutSeconds`                      | When the probe times out                                                                                                                                  | 5                                                            |
| `readinessProbe.failureThreshold`                    | Minimum consecutive failures to be considered failed                                                                                                      | 6                                                            |
| `readinessProbe.successThreshold`                    | Minimum consecutive successes to be considered successful                                                                                                 | 1                                                            |
| `podAnnotations`                                     | Pod annotations                                                                                                                                           | `{}`                                                         |
| `podAffinityPreset`                                  | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`                                                                       | `""`                                                         |
| `podAntiAffinityPreset`                              | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`                                                                  | `soft`                                                       |
| `nodeAffinityPreset.type`                            | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`                                                                 | `""`                                                         |
| `nodeAffinityPreset.key`                             | Node label key to match Ignored if `affinity` is set.                                                                                                     | `""`                                                         |
| `nodeAffinityPreset.values`                          | Node label values to match. Ignored if `affinity` is set.                                                                                                 | `[]`                                                         |
| `affinity`                                           | Affinity for pod assignment                                                                                                                               | `{}` (evaluated as a template)                               |
| `nodeSelector`                                       | Node labels for pod assignment                                                                                                                            | `{}` (evaluated as a template)                               |
| `tolerations`                                        | Tolerations for pod assignment                                                                                                                            | `[]` (evaluated as a template)                               |
| `customLivenessProbe`                                | Override default liveness probe                                                                                                                           | `nil`                                                        |
| `customReadinessProbe`                               | Override default readiness probe                                                                                                                          | `nil`                                                        |
| `extraVolumeMounts`                                  | Array of extra volume mounts to be added to the container (evaluated as template). Normally used with `extraVolumes`.                                     | `nil`                                                        |
| `extraVolumes`                                       | Array of extra volumes to be added to the deployment (evaluated as template). Requires setting `extraVolumeMounts`                                        | `nil`                                                        |
| `lifecycleHooks`                                     | LifecycleHook to set additional configuration at startup Evaluated as a template                                                                          | ``                                                           |
| `extraEnvVarsCM`                                     | ConfigMap containing extra env vars                                                                                                                       | `nil`                                                        |
| `extraEnvVarsSecret`                                 | Secret containing extra env vars (in case of sensitive data)                                                                                              | `nil`                                                        |

### Traffic Exposure Parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `service.type`                                       | Kubernetes Service type                                                                                                                                   | `LoadBalancer`                                               |
| `service.port`                                       | Service HTTP port                                                                                                                                         | `80`                                                         |
| `service.httpsPort`                                  | Service HTTPS port                                                                                                                                        | `443`                                                        |
| `service.loadBalancerIP`                             | Kubernetes LoadBalancerIP to request                                                                                                                      | `nil`                                                        |
| `service.externalTrafficPolicy`                      | Enable client source IP preservation                                                                                                                      | `Cluster`                                                    |
| `service.nodePorts.http`                             | Kubernetes http node port                                                                                                                                 | `""`                                                         |
| `service.nodePorts.https`                            | Kubernetes https node port                                                                                                                                | `""`                                                         |
| `ingress.enabled`                                    | Enable ingress controller resource                                                                                                                        | `false`                                                      |
| `ingress.annotations`                                | Annotations for this ingress record                                                                                                                       | `[]`                                                         |
| `ingress.certManager`                                | Add annotations for cert-manager                                                                                                                          | `false`                                                      |
| `ingress.hosts[0].name`                              | Hostname to your DokuWiki installation                                                                                                                    | `dokuwiki.local`                                             |
| `ingress.hosts[0].path`                              | Path within the url structure                                                                                                                             | `/`                                                          |
| `ingress.hosts[0].tls`                               | Utilize TLS backend in ingress                                                                                                                            | `false`                                                      |
| `ingress.hosts[0].tlsSecret`                         | TLS Secret (certificates)                                                                                                                                 | `dokuwiki.local-tls`                                         |
| `ingress.secrets[0].name`                            | TLS Secret Name                                                                                                                                           | `nil`                                                        |
| `ingress.secrets[0].certificate`                     | TLS Secret Certificate                                                                                                                                    | `nil`                                                        |
| `ingress.secrets[0].key`                             | TLS Secret Key                                                                                                                                            | `nil`                                                        |

### Volume Permissions parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `volumePermissions.enabled`                          | Enable init container that changes volume permissions in the data directory (for cases where the default k8s `runAsUser` and `fsUser` values do not work) | `false`                                                      |
| `volumePermissions.image.registry`                   | Init container volume-permissions image registry                                                                                                          | `docker.io`                                                  |
| `volumePermissions.image.repository`                 | Init container volume-permissions image name                                                                                                              | `bitnami/minideb`                                            |
| `volumePermissions.image.tag`                        | Init container volume-permissions image tag                                                                                                               | `buster`                                                     |
| `volumePermissions.image.pullSecrets`                | Specify docker-registry secret names as an array                                                                                                          | `[]` (does not add image pull secrets to deployed pods)      |
| `volumePermissions.image.pullPolicy`                 | Init container volume-permissions image pull policy                                                                                                       | `Always`                                                     |
| `volumePermissions.resources`                        | Init container resource requests/limit                                                                                                                    | `nil`                                                        |

### Metrics parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `metrics.enabled`                                    | Start a side-car prometheus exporter                                                                                                                      | `false`                                                      |
| `metrics.image.registry`                             | Apache exporter image registry                                                                                                                            | `docker.io`                                                  |
| `metrics.image.repository`                           | Apache exporter image name                                                                                                                                | `bitnami/apache-exporter`                                    |
| `metrics.image.tag`                                  | Apache exporter image tag                                                                                                                                 | `{TAG_NAME}`                                                 |
| `metrics.image.pullPolicy`                           | Image pull policy                                                                                                                                         | `IfNotPresent`                                               |
| `metrics.image.pullSecrets`                          | Specify docker-registry secret names as an array                                                                                                          | `[]` (does not add image pull secrets to deployed pods)      |
| `metrics.podAnnotations`                             | Additional annotations for Metrics exporter pod                                                                                                           | `{prometheus.io/scrape: "true", prometheus.io/port: "9117"}` |
| `metrics.resources`                                  | Exporter resource requests/limit                                                                                                                          | {}                                                           |

### Certificate injection parameters

| Parameter                                            | Description                                                                                                                                               | Default                                                      |
|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `certificates.customCertificate.certificateSecret`   | Secret containing the certificate and key to add                                                                                                          | `""`                                                         |
| `certificates.customCertificate.chainSecret.name`    | Name of the secret containing the certificate chain                                                                                                       | `""`                                                         |
| `certificates.customCertificate.chainSecret.key`     | Key of the certificate chain file inside the secret                                                                                                       | `""`                                                         |
| `certificates.customCertificate.certificateLocation` | Location in the container to store the certificate                                                                                                        | `/etc/ssl/certs/ssl-cert-snakeoil.pem`                       |
| `certificates.customCertificate.keyLocation`         | Location in the container to store the private key                                                                                                        | `/etc/ssl/private/ssl-cert-snakeoil.key`                     |
| `certificates.customCertificate.chainLocation`       | Location in the container to store the certificate chain                                                                                                  | `/etc/ssl/certs/chain.pem`                                   |
| `certificates.customCAs`                             | Defines a list of secrets to import into the container trust store                                                                                        | `[]`                                                         |
| `certificates.image.registry`                        | Container sidecar registry                                                                                                                                | `docker.io`                                                  |
| `certificates.image.repository`                      | Container sidecar image                                                                                                                                   | `bitnami/minideb`                                            |
| `certificates.image.tag`                             | Container sidecar image tag                                                                                                                               | `buster`                                                     |
| `certificates.image.pullPolicy`                      | Container sidecar image pull policy                                                                                                                       | `IfNotPresent`                                               |
| `certificates.image.pullSecrets`                     | Container sidecar image pull secrets                                                                                                                      | `image.pullSecrets`                                          |
| `certificates.args`                                  | Override default container args (useful when using custom images)                                                                                         | `nil`                                                        |
| `certificates.command`                               | Override default container command (useful when using custom images)                                                                                      | `nil`                                                        |
| `certificates.extraEnvVars`                          | Container sidecar extra environment variables (eg proxy)                                                                                                  | `[]`                                                         |
| `certificates.extraEnvVarsCM`                        | ConfigMap containing extra env vars                                                                                                                       | `nil`                                                        |
| `certificates.extraEnvVarsSecret`                    | Secret containing extra env vars (in case of sensitive data)                                                                                              | `nil`                                                        |

The above parameters map to the env variables defined in [bitnami/dokuwiki](http://github.com/bitnami/bitnami-docker-dokuwiki). For more information please refer to the [bitnami/dokuwiki](http://github.com/bitnami/bitnami-docker-dokuwiki) image documentation.

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install my-release \
  --set dokuwikiUsername=admin,dokuwikiPassword=password \
    bitnami/dokuwiki
```

The above command sets the DokuWiki administrator account username and password to `admin` and `password` respectively.

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

```console
$ helm install my-release -f values.yaml bitnami/dokuwiki
```

> **Tip**: You can use the default [values.yaml](values.yaml)

## Configuration and installation details

### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

### Setting Pod's affinity

This chart allows you to set your custom affinity using the `affinity` parameter. Find more information about Pod's affinity in the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity).

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/master/bitnami/common#affinities) chart. To do so, set the `podAffinityPreset`, `podAntiAffinityPreset`, or `nodeAffinityPreset` parameters.

## Persistence

The [Bitnami DokuWiki](https://github.com/bitnami/bitnami-docker-dokuwiki) image stores the DokuWiki data and configurations at the `/bitnami/dokuwiki` path of the container.

Persistent Volume Claims are used to keep the data across deployments. There is a [known issue](https://github.com/kubernetes/kubernetes/issues/39178) in Kubernetes Clusters with EBS in different availability zones. Ensure your cluster is configured properly to create Volumes in the same availability zone where the nodes are running. Kuberentes 1.12 solved this issue with the [Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode).

See the [Parameters](#parameters) section to configure the PVC or to disable persistence.

## Certificates

### CA Certificates

Custom CA certificates not included in the base docker image can be added with
the following configuration. The secret must exist in the same namespace as the
deployment. Will load all certificates files it finds in the secret.

```yaml
certificates:
  customCAs:
  - secret: my-ca-1
  - secret: my-ca-2
```

#### Secret

Secret can be created with:

```bash
kubectl create secret generic my-ca-1 --from-file my-ca-1.crt
```

### TLS Certificate

A web server TLS Certificate can be injected into the container with the
following configuration. The certificate will be stored at the location
specified in the certificateLocation value.

```yaml
certificates:
  customCertificate:
    certificateSecret: my-secret
    certificateLocation: /ssl/server.pem
    keyLocation: /ssl/key.pem
    chainSecret:
      name: my-cert-chain-secret
      key: chain.pem
```

#### Secret

The certificate tls secret can be created with:

```bash
kubectl create secret tls my-secret --cert tls.crt --key tls.key
```

The certificate chain is created with:
```bash
kubectl create secret generic my-ca-1 --from-file my-ca-1.crt
```

## Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in [this troubleshooting guide](https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues).

## Upgrading

### To 10.0.0

[On November 13, 2020, Helm v2 support was formally finished](https://github.com/helm/charts#status-of-the-project), this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

**What changes were introduced in this major version?**

- Previous versions of this Helm Chart use `apiVersion: v1` (installable by both Helm 2 and 3), this Helm Chart was updated to `apiVersion: v2` (installable by Helm 3 only). [Here](https://helm.sh/docs/topics/charts/#the-apiversion-field) you can find more information about the `apiVersion` field.
- Move dependency information from the *requirements.yaml* to the *Chart.yaml*
- After running `helm dependency update`, a *Chart.lock* file is generated containing the same structure used in the previous *requirements.lock*
- The different fields present in the *Chart.yaml* file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

**Considerations when upgrading to this version**

- If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
- If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
- If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the [official Helm documentation](https://helm.sh/docs/topics/v2_v3_migration/#migration-use-cases) about migrating from Helm v2 to v3

**Useful links**

- https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
- https://helm.sh/docs/topics/v2_v3_migration/
- https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

### To 7.0.0

This version also introduces `bitnami/common`, a [library chart](https://helm.sh/docs/topics/library_charts/#helm) as a dependency. More documentation about this new utility could be found [here](https://github.com/bitnami/charts/tree/master/bitnami/common#bitnami-common-library-chart). Please, make sure that you have updated the chart dependencies before executing any upgrade.

The [Bitnami Dokuwiki](https://github.com/bitnami/bitnami-docker-dokuwiki) image was migrated to a "non-root" user approach. Previously the container ran as the `root` user and the Apache daemon was started as the `daemon` user. From now on, both the container and the Apache daemon run as user `1001`. You can revert this behavior by setting the parameters `containerSecurityContext.runAsUser` to `root`.

Consequences:

- The HTTP/HTTPS ports exposed by the container are now `8080/8443` instead of `80/443`.
- Backwards compatibility is not guaranteed.

To upgrade to `7.0.0`, backup Drupal data and the previous MariaDB databases, install a new Drupal chart and import the backups and data, ensuring the `1001` user has the appropriate permissions on the migrated volume.

### To 6.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17294 the `apiVersion` of the deployment resources was updated to `apps/v1` in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

### To 3.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments.
Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is dokuwiki:

```console
$ kubectl patch deployment dokuwiki-dokuwiki --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
```
