mindzy / outline-helm-chart

A helm chart that makes it easy to deploy outline wiki (https://github.com/outline/outline) on kubernetes with all of its dependencies or without

Outline wiki helm chart

This helm chart provides you with a ready to use outline wiki stack ready to deploy in your kubernetes cluster. It provides:

• Outline
• PostgreSQL
• Redis
• Minio S3 Storage

You can enable or disable every outline dependency like postgresql, minio or redis and also provide your own with your own configuration. You are also able to re-configure most of all settings from the provided dependencies and defaults.

Quick start

At first check all variables that need to be set, especially the credentials and secrets within the values.yaml. Do only use self-generated secrets and credentials for production environments.

helm upgrade --install -n outline --create-namespace --set postgresql.postgresqlPassword=some-secret-db-pass,postgresql.postgresqlPostgresPassword=some-secret-admin-db-pass,minio.secretKey.password=some-secret-s3-secret,minio.accessKey.password=some-secret-s3-accesskey,env.SLACK_SECRET=slack-oidc-secret,env.SLACK_KEY=slack-oidc-key outline ./

To find out more configuration possibilities also check the values.yaml.

Example values.yaml with slack as oidc provider and tls via cert-manager

secretKey: "to-generate-see-values-yaml-docs"
utilsSecret: "to-generate-see-values-yaml-docs"
ingress:
  host: outline.somedomain.tld
  tls:
    enabled: true
    annotations:
      cert-manager.io/cluster-issuer: "letsencrypt-staging"
env:
  SLACK_KEY: "your-slack-app-key"
  SLACK_SECRET: "your-slack-secret"
  SMTP_HOST: "some-smtp-host"
  SMTP_PORT: "25"
  SMTP_USERNAME: "smtp-user"
  SMTP_PASSWORD: "smtp-passwd"
  SMTP_FROM_EMAIL: "[email protected]"
  SMTP_REPLY_EMAIL: "[email protected]"
  SMTP_SECURE: "false"
postgresql:
  postgresqlPassword: "some-secret-pw"
  postgresqlPostgresPassword: "some-secret-pw-admin"
  persistence:
    storageClass: "some-storage-class"
    size: 6Gi
redis:
  persistence:
    storageClass: "some-storage-class"
    size: 3Gi
minio:
  ingress:
    hostname: "data.outline.somedomain.tld"
    certManager: true
    tls: true
    annotations:
      cert-manager.io/cluster-issuer: "letsencrypt-staging"
  secretKey:
    password: "some-secret-pw"
  accessKey:
    password: "some-secret-pw"
  persistence:
    storageClass: "some-storage-class"
    size: 30Gi

Tips

If you have problems with loading images or some kind of contentType mismatch while loading avatars or images there might be some fix you need to apply to minio s3 server. Open a shell in the minio pod/container or connect with a minio mc client to the minio server and execute the following policies. This bugfix is also documented here.

Example within the minio pod (e.g. minio runs on localhost)

mc alias set minio http://localhost:9000 your-minio-access-key your-minio-secret
mc policy set public minio/ol-data/public

The path for the policy targets the public directory in the outline s3 bucket.

Contribute

Feel free to contribute and create pull requests. We will review and merge them.

Credits

This is open source software by encircle360. Use on your own risk and for personal use. If you need support or consultancy just contact us.