Files
wekan/secrets
Lauri Ojansivu b7589737f5 File docs/Features the way the WeKan menus are.
A feature's guide now sits under the menu it is used from, read from the
templates rather than from where somebody once put it: Header-Bar,
All-Boards, Pages, Board-Header (search and every Board View), Board-Sidebar
(Board Settings, Filter, Members, Labels, Archive), Rules, Swimlanes, Lists,
Cards, Member-Settings, Admin-Panel and Login-Page. Topics used from several
menus (editor, history, theme, translations, email, troubleshooting) are in
General.

- Each area has a README mapping its menu entries to their guides and to the
  template or server module that implements them. Board-Header/README.md
  lists all 40 Board View entries with the template boardBody.jade renders;
  five views (Table, Calendar Mode, Time, Timeline, Map) have no guide of
  their own yet and say so.
- Board-View.md listed 25 views while BOARD_VIEWS has 40; it now lists all
  of them with their English labels.
- Pages keep their file names. Where a released changelog links an old path,
  a "# Moved" page stays there and points to the new one; test-menu.sh skips
  folders holding only those.
- Undo was filed under Login; it is General/Undo now.
- Every link in docs, code comments, scripts and tests follows the move;
  docsLinksResolve checks them all.

Tests that read a doc follow it to its new place. boardViewSettings now fails
when Board-View.md or Board-Header/README.md differs from BOARD_VIEWS, or
names a template boardBody.jade does not render.

Thanks to xet7 !
2026-10-16 23:45:35 +03:00
..

Wekan Docker Compose Secrets

This directory contains example secret files for Wekan Docker Compose deployment. These files should be used instead of environment variables for better security and GitOps compatibility.

Secret Files

WeKan reads these itself, at each login, so the password is never put in an environment variable:

  • LDAP_AUTHENTIFICATION_PASSWORD_FILE - ldap_auth_password.txt, the LDAP search user's password
  • OAUTH2_SECRET_FILE - oauth2_secret.txt, the OAuth2 / OpenID Connect client secret
  • OAUTH_<PROVIDER>_SECRET_FILE - the secret of a Meteor accounts login provider; <PROVIDER> is one of GOOGLE, GITHUB, FACEBOOK, TWITTER, METEOR_DEVELOPER, WEIBO, MEETUP (see docs/Features/Login-Page/OAuth-Providers.md)

The variable itself (for example LDAP_AUTHENTIFICATION_PASSWORD) wins over its file when both are set, and a value saved in Admin Panel / People wins over both. One trailing line break in the file is ignored; every other character is part of the password. Admin Panel / People shows when the password comes from the file, and when the file cannot be read.

WeKan also reads these, once when it starts (#5724):

  • MONGO_URL_FILE - mongo_url.txt, the whole MongoDB URL, password included. Meteor connects to the database before any WeKan code runs, so the start scripts, the snap and the Docker entrypoint read this file and start WeKan with MONGO_URL set from it.
  • MAIL_URL_FILE - mail_url.txt, the whole SMTP URL, password included.
  • S3_SECRET_KEY_FILE - s3_secret_key.txt, the S3 / MinIO secret access key (S3_SECRET_KEY).

As with the others, the variable wins over its file when both are set. MAIL_SERVICE_PASSWORD_FILE, MONGO_PASSWORD_FILE and S3_SECRET_FILE, which older examples showed, were never read; WeKan logs a warning naming the replacement when one of them is still set.

On the snap, WeKan can read files under /var/snap/wekan/common, for example snap set wekan ldap-authentication-password-file='/var/snap/wekan/common/secrets/ldap_auth_password'.

Usage

  1. Copy the example files and replace the placeholder values with your actual secrets
  2. Update your docker-compose.yml to use the _FILE environment variables
  3. Ensure the secret files are properly secured with appropriate file permissions

Security Notes

  • Never commit actual secret values to version control
  • Set appropriate file permissions (e.g., chmod 600 secrets/*.txt)
  • Consider using a secrets management system in production
  • The secret files are mounted as read-only in the container

Docker Compose Configuration

Example configuration in docker-compose.yml:

services:
  wekan:
    environment:
      - LDAP_AUTHENTIFICATION_PASSWORD_FILE=/run/secrets/ldap_auth_password
      - OAUTH2_SECRET_FILE=/run/secrets/oauth2_secret
      - MAIL_URL_FILE=/run/secrets/mail_url
      - MONGO_URL_FILE=/run/secrets/mongo_url
      - S3_SECRET_KEY_FILE=/run/secrets/s3_secret_key
    secrets:
      - ldap_auth_password
      - oauth2_secret
      - mail_url
      - mongo_url
      - s3_secret_key

secrets:
  ldap_auth_password:
    file: ./secrets/ldap_auth_password.txt
  oauth2_secret:
    file: ./secrets/oauth2_secret.txt
  mail_url:
    file: ./secrets/mail_url.txt
  mongo_url:
    file: ./secrets/mongo_url.txt
  s3_secret_key:
    file: ./secrets/s3_secret_key.txt