Skip to content
Docmost icon
v1.4.8App: v0.96.0Pinned DigestS3 Backup Ready

Production Helm chart • Apache-2.0 • Zero-Root • Verified on Kubernetes v1.33-v1.36+

Docmost

A Helm chart for deploying Docmost on Kubernetes with PostgreSQL, Redis, local storage, Gateway API, Ingress, External Secrets, and optional S3-compatible object storage.

Installation

HTTPS Repository

helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install docmost helmforge/docmost

OCI Registry

helm install docmost oci://ghcr.io/helmforgedev/helm/docmost

Features

  • Official Docmost image based on docmost/docmost
  • PostgreSQL subchart bundled PostgreSQL 2.2.0 for default installs
  • Redis subchart bundled Redis 3.2.1 for default installs
  • External services support for managed PostgreSQL and Redis
  • Local or S3 storage for uploaded files
  • Ingress support configurable ingress with TLS
  • Gateway API HTTPRoute support for clusters using Gateway API
  • External Secrets Operator integration for secret material sourced outside Helm
  • Dual-stack service controls through service.ipFamilyPolicy and service.ipFamilies
  • Optional backup CronJob for PostgreSQL dumps uploaded to S3-compatible storage
  • Workload identity backups with a dedicated annotated ServiceAccount and no static S3 keys
  • Common resource annotations with resource-specific annotations taking precedence
  • Values schema values.schema.json validates chart inputs and improves Artifact Hub rendering

Important Notes

  • replicaCount values greater than 1 require storage.mode=s3
  • Docmost requires PostgreSQL and Redis
  • local storage uses /app/data/storage
  • S3 mode uses the official AWS_S3_* environment variables documented by Docmost
  • the default image tag is 0.96.0, validated against the published docmost/docmost:0.96.0 container image
  • upstream telemetry can be disabled with docmost.disableTelemetry=true
  • this chart intentionally does not keep Chart.lock; dependencies are resolved by the repository release workflow

Architecture

Traffic reaches the named http container port through the Kubernetes Service. containerPorts.http changes the actual Docmost process listener by setting the upstream PORT environment variable; service.port changes only the Kubernetes-facing port. PostgreSQL and Redis may be bundled or external, while uploads use either a local PVC or S3-compatible storage. See Chart design for trust boundaries and production trade-offs.

The pod does not mount a Kubernetes API token by default. Set serviceAccount.automountServiceAccountToken=true only when a concrete integration requires Kubernetes API credentials.

Upgrade to 0.96

Keep APP_SECRET stable: the new AES-256-GCM encryption service derives its key from this existing secret. Back up PostgreSQL and uploaded files before upgrading. The chart reuses its generated application Secret on connected Helm upgrades; explicitly manage docmost.appSecret when rendering offline, or point docmost.existingSecret at a secret you own so the chart neither creates nor rotates one.

This release updates Node and collaboration services, adds page-version comparison and attachments, fixes Redis ACL/URL/TLS handling, and includes security fixes. Review the official release notes. The bundled Redis chart moves to 3.0.0; its application image, default standalone storage and authentication contracts are unchanged, while its TLS probes are fixed.

Quick Start

helm install docmost oci://ghcr.io/helmforgedev/helm/docmost \
  --set ingress.enabled=true \
  --set ingress.ingressClassName=traefik \
  --set ingress.hosts[0].host=docmost.example.com \
  --set ingress.hosts[0].paths[0].path=/ \
  --set ingress.hosts[0].paths[0].pathType=Prefix

Example Configurations

Basic Install

docmost:
  appUrl: https://docmost.example.com

ingress:
  enabled: true
  ingressClassName: traefik
  hosts:
    - host: docmost.example.com
      paths:
        - path: /
          pathType: Prefix

External Services with S3

database:
  mode: external
  external:
    host: postgres.example.internal
    existingSecret: docmost-db

postgresql:
  enabled: false

redis:
  enabled: false
  external:
    host: redis.example.internal
    existingSecret: docmost-redis

storage:
  mode: s3
  s3:
    bucket: docmost
    endpoint: https://minio.example.internal
    existingSecret: docmost-s3

Gateway API

gateway:
  enabled: true
  parentRefs:
    - name: shared-gateway
      namespace: gateway-system
  hostnames:
    - docmost.example.com

Dual-Stack Service

service:
  ipFamilyPolicy: PreferDualStack
  ipFamilies:
    - IPv4
    - IPv6

External Secrets

externalSecrets:
  enabled: true
  secretStoreRef:
    name: platform-secrets
    kind: ClusterSecretStore
  data:
    - secretKey: database-password
      remoteRef:
        key: docmost/database
        property: password

PostgreSQL Backup to S3

backup:
  enabled: true
  schedule: "0 3 * * *"
  s3:
    endpoint: https://minio.example.internal
    bucket: backups
    prefix: docmost
    existingSecret: docmost-backup-s3

For Amazon S3 with IRSA, omit static credentials and annotate the dedicated backup ServiceAccount:

backup:
  enabled: true
  serviceAccount:
    annotations:
      eks.amazonaws.com/role-arn: arn:aws:iam::123456789012:role/docmost-backup
  s3:
    endpoint: https://s3.amazonaws.com
    region: us-east-1
    bucket: backups
    credentialsFromPodIdentity: true

For EKS Pod Identity, do not add the IRSA annotation. Set a stable ServiceAccount name, install the EKS Pod Identity Agent add-on when the cluster does not use EKS Auto Mode, and create an AWS-side association for the cluster, namespace, and ServiceAccount:

backup:
  enabled: true
  serviceAccount:
    name: docmost-backup
  s3:
    endpoint: https://s3.amazonaws.com
    region: us-east-1
    bucket: backups
    credentialsFromPodIdentity: true
Official Schema

Values & Configuration Reference

All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.

View Values Schema

|-----|---------|-------------| | replicaCount | 1 | Number of Docmost application pods. Values greater than 1 require storage.mode=s3 | | strategy | {} | Deployment update strategy. Defaults to Recreate while the local uploads PVC is in use, since that volume is ReadWriteOnce, and to RollingUpdate otherwise | | image.repository | docker.io/docmost/docmost | Docmost container image repository | | image.tag | 0.96.0 | Docmost image tag | | containerPorts.http | 3000 | Docmost process listener and declared container port | | docmost.appUrl | "" | External Docmost URL | | docmost.appSecret | "" | Application secret, auto-generated when empty | | docmost.existingSecret | "" | Existing secret holding the app secret. Takes precedence over appSecret and stops the chart creating or rotating one | | docmost.existingSecretAppSecretKey | app-secret | Key for the app secret inside docmost.existingSecret | | docmost.jwtTokenExpiresIn | 30d | JWT expiration | | docmost.disableTelemetry | false | Disable anonymous upstream telemetry collection | | database.mode | auto | Database mode: auto, external, postgresql | | postgresql.enabled | true | Deploy PostgreSQL subchart | | postgresql.auth.database | docmost | PostgreSQL database created by the subchart | | postgresql.auth.username | docmost | PostgreSQL application user created by the subchart | | redis.enabled | true | Deploy Redis subchart | | redis.auth.enabled | true | Enable Redis password authentication | | storage.mode | local | File storage mode: local or s3 | | storage.local.enabled | true | Create or mount local uploads storage | | storage.local.size | 10Gi | Local uploads PVC size | | storage.s3.bucket | "" | S3 bucket name | | backup.enabled | false | Enable the PostgreSQL backup CronJob | | backup.schedule | 0 3 * * * | Backup Cron schedule | | backup.s3.credentialsFromPodIdentity | false | Use EKS Pod Identity or IRSA instead of static S3 keys | | backup.serviceAccount.create | true | Create the dedicated backup ServiceAccount | | backup.serviceAccount.annotations | {} | Workload identity annotations for the backup ServiceAccount | | resources.requests.memory | 512Mi | Docmost memory request | | resources.limits.memory | 1Gi | Docmost memory limit | | service.port | 80 | Service port exposed by Kubernetes | | service.ipFamilyPolicy | "" | Kubernetes service IP family policy | | service.ipFamilies | [] | Kubernetes service IP families | | serviceAccount.automountServiceAccountToken | false | Mount the Kubernetes API token into Docmost pods | | ingress.enabled | false | Enable ingress | | ingress.ingressClassName | "" | Ingress class (traefik, nginx, etc.) | | gateway.enabled | false | Render a Gateway API HTTPRoute | | externalSecrets.enabled | false | Render an ExternalSecret for application credentials |

Operations

The post-install notes include port-forward, application logs, PostgreSQL logs, Redis logs, and upgrade reminders. For production upgrades, take a database backup first and verify the secret references used by database.external.*, redis.external.*, storage.s3.*, and backup.s3.*.

Troubleshooting

  • If probes fail after changing the listener, confirm that containerPorts.http appears both as the container port and as the PORT environment variable. Do not use service.port to change the process.
  • If the application starts but cannot persist data, inspect the PostgreSQL and Redis pod logs, then verify the rendered DATABASE_URL and REDIS_URL Secret references.
  • If uploaded files disappear across replicas, use storage.mode=s3; local storage is intentionally limited to one Docmost replica.
  • If encrypted values become unreadable after an upgrade or restore, restore the same APP_SECRET through docmost.existingSecret.
  • For S3 failures, verify endpoint reachability, bucket policy, path-style mode, and both keys in storage.s3.existingSecret.
  • For IRSA backup failures, verify backup.s3.region, the dedicated ServiceAccount role annotation, and the IAM trust policy. For EKS Pod Identity, verify the agent add-on and the AWS-side cluster, namespace, and ServiceAccount association; Pod Identity does not use the IRSA annotation.

More Information

Security Scan: docmost

Framework Score
MITRE + NSA + SOC2 87.87879%

✅ Security posture acceptable.

| commonAnnotations | {} | Annotations added to all chart-owned resources |

System Architecture

DESIGN.md Synced

Verified architecture contract rendered dynamically from GitHub DESIGN.md

flowchart LR
  user[Users and clients] --> route[Ingress or HTTPRoute]
  route --> service[Service]
  service --> app[Docmost Deployment]
  app --> postgres[(PostgreSQL)]
  app --> redis[(Redis)]
  app --> storage[(Local PVC or S3)]
  secret[Secret or ExternalSecret] --> app
  identity[Dedicated backup ServiceAccount] --> backup[Optional backup CronJob]
  backup --> postgres
  backup --> backupStore[(S3 backup bucket)]
Official Contractvalues.schema.json

Docmost Values Schema Reference

Official schema parameters, default values, and types extracted directly from the chart repository.

149 parametersValues Studio

Global(1)

ParameterTypeDefaultDescription
globalobject-Global settings shared by the chart.

Name Override(1)

ParameterTypeDefaultDescription
nameOverridestring-Override the chart name used in resource names

Fullname Override(1)

ParameterTypeDefaultDescription
fullnameOverridestring-Override the full release name used in resource names

Common Labels(1)

ParameterTypeDefaultDescription
commonLabelsobject-Labels added to every resource created by this chart

Common Annotations(1)

ParameterTypeDefaultDescription
commonAnnotationsobject-Annotations added to every resource created by this chart

Replica Count(1)

ParameterTypeDefaultDescription
replicaCountinteger-Number of Docmost application replicas. Values greater than 1 require storage.mode=s3.

Strategy(1)

ParameterTypeDefaultDescription
strategyobject-Deployment update strategy. When empty, defaults to Recreate if the local uploads PVC is in use and RollingUpdate otherwise.

Image(3)

ParameterTypeDefaultDescription
image.repositorystring-Docmost container image repository
image.tagstring-Docmost image tag. Defaults to appVersion validated on GitHub Releases and Docker Hub.
image.pullPolicystring-Image pull policy
Allowed:AlwaysIfNotPresentNever

Image Pull Secrets(1)

ParameterTypeDefaultDescription
imagePullSecretsarray-Image pull secrets for private registries

Container Ports(1)

ParameterTypeDefaultDescription
containerPorts.httpinteger-HTTP listener used by the Docmost process and container.

Docmost(7)

ParameterTypeDefaultDescription
docmost.appUrlstring-Full external URL for Docmost. Auto-detected from the first ingress host when empty.
docmost.appSecretstring-Secret key for application security. Auto-generated if empty.
docmost.existingSecretstring-Existing secret holding the app secret. Takes precedence over appSecret and stops the chart creating or rotating one.
docmost.existingSecretAppSecretKeystring-Secret key for the app secret in docmost.existingSecret.
docmost.jwtTokenExpiresInstring-JWT expiration used by Docmost
docmost.disableTelemetryboolean-Disable anonymous upstream telemetry collection
docmost.extraEnvarray-Additional environment variables for the Docmost container

Database(8)

ParameterTypeDefaultDescription
database.modestring-Database mode: auto | external | postgresql
Allowed:autoexternalpostgresql
database.external.hoststring-External PostgreSQL hostname
database.external.portinteger-External PostgreSQL port
database.external.namestring-External PostgreSQL database name
database.external.usernamestring-External PostgreSQL username
database.external.passwordstring-External PostgreSQL password. Ignored when existingSecret is set.
database.external.existingSecretstring-Existing secret containing the external PostgreSQL password
database.external.existingSecretPasswordKeystring-Secret key for the external PostgreSQL password

Postgresql(4)

ParameterTypeDefaultDescription
postgresql.enabledboolean-Deploy PostgreSQL as a subchart
postgresql.architecturestring-PostgreSQL architecture
postgresql.authobject-PostgreSQL authentication settings
postgresql.primaryobject-Primary PostgreSQL settings

Redis(9)

ParameterTypeDefaultDescription
redis.enabledboolean-Deploy Redis as a subchart
redis.architecturestring-Redis architecture
redis.authobject-Redis authentication settings
redis.standaloneobject-Standalone Redis settings
redis.external.hoststring-External Redis hostname
redis.external.portinteger-External Redis port
redis.external.passwordstring-External Redis password. Ignored when existingSecret is set.
redis.external.existingSecretstring-Existing secret containing the external Redis password
redis.external.existingSecretPasswordKeystring-Secret key for the external Redis password

Storage(16)

ParameterTypeDefaultDescription
storage.modestring-Storage mode: local | s3
Allowed:locals3
storage.local.enabledboolean-Enable persistent local storage for uploaded files
storage.local.storageClassstring-Storage class for the Docmost uploads PVC
storage.local.accessModestring-Access mode for the Docmost uploads PVC
storage.local.sizestring-Size of the Docmost uploads PVC
storage.local.existingClaimstring-Existing PVC claim for local uploads storage
storage.local.annotationsobject-Annotations for the Docmost uploads PVC
storage.s3.regionstring-S3 region
storage.s3.bucketstring-S3 bucket name
storage.s3.endpointstring-S3 endpoint URL
storage.s3.forcePathStyleboolean-Force path-style requests for S3-compatible providers
storage.s3.accessKeystring-S3 access key. Ignored when existingSecret is set.
storage.s3.secretKeystring-S3 secret key. Ignored when existingSecret is set.
storage.s3.existingSecretstring-Existing secret containing S3 credentials
storage.s3.existingSecretAccessKeyKeystring-Secret key for the S3 access key in storage.s3.existingSecret
storage.s3.existingSecretSecretKeyKeystring-Secret key for the S3 secret key in storage.s3.existingSecret

Backup(27)

ParameterTypeDefaultDescription
backup.enabledboolean-Enable built-in backup CronJob for PostgreSQL (pg_dump to S3)
backup.schedulestring-Backup schedule in Cron format
backup.suspendboolean-Suspend backup execution
backup.concurrencyPolicystring-CronJob concurrency policy
Allowed:AllowForbidReplace
backup.successfulJobsHistoryLimitinteger-Successful job history retained by the CronJob
backup.failedJobsHistoryLimitinteger-Failed job history retained by the CronJob
backup.backoffLimitinteger-Job backoff limit
backup.archivePrefixstring-Prefix used in generated backup archive names
backup.images.postgresqlstring-PostgreSQL client image used for pg_dump
backup.images.uploaderstring-MinIO client image used for S3 upload
backup.resourcesobject-Resources applied to the backup dump and upload containers
backup.serviceAccount.createboolean-Create a dedicated ServiceAccount for backup jobs
backup.serviceAccount.namestring-Existing dedicated ServiceAccount name when create is false
backup.serviceAccount.annotationsobject-Annotations for workload identity integrations
backup.serviceAccount.automountServiceAccountTokenboolean-Mount the Kubernetes API token into backup pods
backup.database.pgDumpArgsstring-Extra arguments passed to pg_dump
backup.s3.endpointstring-S3-compatible endpoint URL
backup.s3.regionstring-AWS region used by workload identity and regional bucket creation
backup.s3.bucketstring-Target bucket name
backup.s3.prefixstring-Optional key prefix inside the bucket
backup.s3.createBucketIfNotExistsboolean-Create the bucket automatically when it does not exist yet
backup.s3.existingSecretstring-Existing secret containing access-key and secret-key
backup.s3.existingSecretAccessKeyKeystring-Secret key name for the access key inside backup.s3.existingSecret
backup.s3.existingSecretSecretKeyKeystring-Secret key name for the secret key inside backup.s3.existingSecret
backup.s3.accessKeystring-Inline access key used when backup.s3.existingSecret is not set
backup.s3.secretKeystring-Inline secret key used when backup.s3.existingSecret is not set
backup.s3.credentialsFromPodIdentityboolean-Use EKS Pod Identity or IRSA instead of static S3 credentials

Service & Networking(5)

ParameterTypeDefaultDescription
service.typestring-Service type for the Docmost HTTP service
Allowed:ClusterIPNodePortLoadBalancer
service.portinteger-Service port exposed by the Docmost service
service.ipFamilyPolicystring-Service IP family policy (GR-058)
Allowed:SingleStackPreferDualStackRequireDualStack
service.ipFamiliesarray-Service IP families (GR-058)
service.annotationsobject-Annotations for the Docmost service

Ingress(5)

ParameterTypeDefaultDescription
ingress.enabledboolean-Enable ingress for Docmost
ingress.ingressClassNamestring-Ingress class name
ingress.annotationsobject-Ingress annotations
ingress.hostsarray-Ingress hosts
ingress.tlsarray-Ingress TLS configuration

Startup Probe(6)

ParameterTypeDefaultDescription
startupProbe.enabledboolean-Enable the startup probe
startupProbe.pathstring-HTTP path used by the startup probe
startupProbe.initialDelaySecondsinteger-Initial startup probe delay
startupProbe.periodSecondsinteger-Startup probe interval
startupProbe.timeoutSecondsinteger-Startup probe timeout
startupProbe.failureThresholdinteger-Startup probe failure threshold

Liveness Probe(6)

ParameterTypeDefaultDescription
livenessProbe.enabledboolean-Enable the liveness probe
livenessProbe.pathstring-HTTP path used by the liveness probe
livenessProbe.initialDelaySecondsinteger-Initial liveness probe delay
livenessProbe.periodSecondsinteger-Liveness probe interval
livenessProbe.timeoutSecondsinteger-Liveness probe timeout
livenessProbe.failureThresholdinteger-Liveness probe failure threshold

Readiness Probe(6)

ParameterTypeDefaultDescription
readinessProbe.enabledboolean-Enable the readiness probe
readinessProbe.pathstring-HTTP path used by the readiness probe
readinessProbe.initialDelaySecondsinteger-Initial readiness probe delay
readinessProbe.periodSecondsinteger-Readiness probe interval
readinessProbe.timeoutSecondsinteger-Readiness probe timeout
readinessProbe.failureThresholdinteger-Readiness probe failure threshold

Resources(1)

ParameterTypeDefaultDescription
resourcesobject-CPU and memory requests/limits for the Docmost container

Pod Security(1)

ParameterTypeDefaultDescription
podSecurityContextobject-Pod-level Kubernetes security context

Container Security(1)

ParameterTypeDefaultDescription
securityContextobject-Container-level Kubernetes security context

Wait For Services(2)

ParameterTypeDefaultDescription
waitForServices.resourcesobject-Kubernetes resource requirements for dependency wait containers
waitForServices.securityContextobject-Kubernetes security context for dependency wait containers

Service Account(4)

ParameterTypeDefaultDescription
serviceAccount.createboolean-Create a dedicated ServiceAccount
serviceAccount.namestring-ServiceAccount name override
serviceAccount.annotationsobject-Annotations for the ServiceAccount
serviceAccount.automountServiceAccountTokenboolean-Mount the Kubernetes API token into Docmost pods

Node Selector(1)

ParameterTypeDefaultDescription
nodeSelectorobject-Node selector for pod scheduling

Tolerations(1)

ParameterTypeDefaultDescription
tolerationsarray-Tolerations for pod scheduling

Affinity(1)

ParameterTypeDefaultDescription
affinityobject-Affinity rules for pod scheduling

Priority Class Name(1)

ParameterTypeDefaultDescription
priorityClassNamestring-Priority class name

Termination Grace Period Seconds(1)

ParameterTypeDefaultDescription
terminationGracePeriodSecondsinteger-Grace period for shutdown, in seconds

Pod Labels(1)

ParameterTypeDefaultDescription
podLabelsobject-Additional labels for the Docmost pod

Pod Annotations(1)

ParameterTypeDefaultDescription
podAnnotationsobject-Additional annotations for the Docmost pod

Extra Volume Mounts(1)

ParameterTypeDefaultDescription
extraVolumeMountsarray-Additional volume mounts for the Docmost container

Extra Volumes(1)

ParameterTypeDefaultDescription
extraVolumesarray-Additional volumes for the Docmost pod

Extra Manifests(1)

ParameterTypeDefaultDescription
extraManifestsarray-Extra Kubernetes manifests to deploy alongside the chart

Gateway(6)

ParameterTypeDefaultDescription
gateway.enabledbooleanfalseChart configuration parameter
gateway.annotationsobject-Chart configuration parameter
gateway.parentRefsarray-Chart configuration parameter
gateway.hostnamesarray-Chart configuration parameter
gateway.pathstring/Chart configuration parameter
gateway.pathTypestringPathPrefixChart configuration parameter
Allowed:PathPrefixExactRegularExpression

Gateway API(6)

ParameterTypeDefaultDescription
gatewayAPI.enabledbooleanfalseChart configuration parameter
gatewayAPI.annotationsobject-Chart configuration parameter
gatewayAPI.parentRefsarray-Chart configuration parameter
gatewayAPI.hostnamesarray-Chart configuration parameter
gatewayAPI.pathstring/Chart configuration parameter
gatewayAPI.pathTypestringPathPrefixChart configuration parameter
Allowed:PathPrefixExactRegularExpression

External Secrets(7)

ParameterTypeDefaultDescription
externalSecrets.enabledbooleanfalseChart configuration parameter
externalSecrets.apiVersionstringexternal-secrets.io/v1Chart configuration parameter
externalSecrets.refreshIntervalstring1hChart configuration parameter
externalSecrets.secretStoreRef.namestring-Chart configuration parameter
externalSecrets.secretStoreRef.kindstring-Chart configuration parameter
externalSecrets.target.creationPolicystring-Chart configuration parameter
externalSecrets.dataarray-Chart configuration parameter