docker-compose.yml-arm64 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817
  1. version: '2'
  2. #---------------------------------------------------------------------------------------------------------
  3. # ==== START ====
  4. # docker-compose up -d -f docker-compose.yml-arm64
  5. #---------------------------------------------------------------------------------------------------------
  6. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  7. #---------------------------------------------------------------------------------------------------------
  8. # ==== CREATING USERS AND LOGGING IN TO WEKAN ====
  9. # https://github.com/wekan/wekan/wiki/Adding-users
  10. #---------------------------------------------------------------------------------------------------------
  11. # ==== FORGOT PASSWORD ====
  12. # https://github.com/wekan/wekan/wiki/Forgot-Password
  13. #---------------------------------------------------------------------------------------------------------
  14. # ==== Upgrading Wekan to new version =====
  15. # NOTE: MongoDB has changed from 3.x to 4.x, in that case you need backup/restore with --noIndexRestore
  16. # see https://github.com/wekan/wekan/wiki/Backup
  17. # 1) Stop Wekan:
  18. # docker-compose stop
  19. # 2) Remove old Wekan app (wekan-app only, not that wekan-db container that has all your data)
  20. # docker rm wekan-app
  21. # 3) Get newest docker-compose.yml from https://github.com/wekan/wekan to have correct image,
  22. # for example: "image: quay.io/wekan/wekan" or version tag "image: quay.io/wekan/wekan:v4.52"
  23. # 4) Start Wekan:
  24. # docker-compose up -d
  25. #----------------------------------------------------------------------------------
  26. # ==== OPTIONAL: DEDICATED DOCKER USER ====
  27. # 1) Optionally create a dedicated user for Wekan, for example:
  28. # sudo useradd -d /home/wekan -m -s /bin/bash wekan
  29. # 2) Add this user to the docker group, then logout+login or reboot:
  30. # sudo usermod -aG docker wekan
  31. # 3) Then login as user wekan.
  32. # 4) Create this file /home/wekan/docker-compose.yml with your modifications.
  33. #----------------------------------------------------------------------------------
  34. # ==== RUN DOCKER AS SERVICE ====
  35. # 1a) Running Docker as service, on Systemd like Debian 9, Ubuntu 16.04, CentOS 7:
  36. # sudo systemctl enable docker
  37. # sudo systemctl start docker
  38. # 1b) Running Docker as service, on init.d like Debian 8, Ubuntu 14.04, CentOS 6:
  39. # sudo update-rc.d docker defaults
  40. # sudo service docker start
  41. # ----------------------------------------------------------------------------------
  42. # ==== USAGE OF THIS docker-compose.yml ====
  43. # 1) For seeing does Wekan work, try this and check with your web browser:
  44. # docker-compose up
  45. # 2) Stop Wekan and start Wekan in background:
  46. # docker-compose stop
  47. # docker-compose up -d
  48. # 3) See running Docker containers:
  49. # docker ps
  50. # 4) Stop Docker containers:
  51. # docker-compose stop
  52. # ----------------------------------------------------------------------------------
  53. # ===== INSIDE DOCKER CONTAINERS, AND BACKUP/RESTORE ====
  54. # https://github.com/wekan/wekan/wiki/Backup
  55. # If really necessary, repair MongoDB: https://github.com/wekan/wekan-mongodb/issues/6#issuecomment-424004116
  56. # 1) Going inside containers:
  57. # a) Wekan app, does not contain data
  58. # docker exec -it wekan-app bash
  59. # b) MongoDB, contains all data
  60. # docker exec -it wekan-db bash
  61. # 2) Copying database to outside of container:
  62. # docker exec -it wekan-db bash
  63. # cd /data
  64. # mongodump
  65. # exit
  66. # docker cp wekan-db:/data/dump .
  67. # 3) Restoring database
  68. # # 1) Stop wekan
  69. # docker stop wekan-app
  70. # # 2) Go inside database container
  71. # docker exec -it wekan-db bash
  72. # # 3) and data directory
  73. # cd /data
  74. # # 4) Remove previous dump
  75. # rm -rf dump
  76. # # 5) Exit db container
  77. # exit
  78. # # 6) Copy dump to inside docker container
  79. # docker cp dump wekan-db:/data/
  80. # # 7) Go inside database container
  81. # docker exec -it wekan-db bash
  82. # # 8) and data directory
  83. # cd /data
  84. # # 9) Restore
  85. # mongorestore --drop
  86. # # 10) Exit db container
  87. # exit
  88. # # 11) Start wekan
  89. # docker start wekan-app
  90. #-------------------------------------------------------------------------
  91. services:
  92. wekandb:
  93. #-------------------------------------------------------------------------------------
  94. # ==== MONGODB FROM DOCKER HUB ====
  95. image: mongo:6
  96. #-------------------------------------------------------------------------------------
  97. container_name: wekan-db
  98. restart: always
  99. # command: mongod --oplogSize 128
  100. # Syslog: mongod --syslog --oplogSize 128 --quiet
  101. # Disable MongoDB logs:
  102. command: mongod --logpath /dev/null --oplogSize 128 --quiet
  103. networks:
  104. - wekan-tier
  105. expose:
  106. - 27017
  107. volumes:
  108. - /etc/localtime:/etc/localtime:ro
  109. - wekan-db:/data/db
  110. - wekan-db-dump:/dump
  111. #- /etc/timezone:/etc/timezone:ro # Do not use https://github.com/wekan/wekan/issues/5123
  112. wekan:
  113. #-------------------------------------------------------------------------------------
  114. # ==== WEKAN FROM GITHUB/QUAY/DOCKER HUB ====
  115. # All of GitHub, Quay and Docker Hub have latest, but because
  116. # latest tag changes when is newest release,
  117. # when upgrading would be better to use version tag.
  118. # a) Using specific version tag is better:
  119. # image: ghcr.io/wekan/wekan:v6.89
  120. # image: quay.io/wekan/wekan:v6.89
  121. # image: wekanteam/wekan:v6.89
  122. # b) GitHub Container registry.
  123. #image: ghcr.io/wekan/wekan:main
  124. image: ghcr.io/wekan/wekan:v7.09-arm64
  125. # c) Quay:
  126. #image: quay.io/wekan/wekan:latest
  127. # d) Docker Hub:
  128. #image: wekanteam/wekan:latest
  129. #-------------------------------------------------------------------------------------
  130. container_name: wekan-app
  131. # On CentOS 7 there is seccomp issue with glibc 6,
  132. # so CentOS 7 users shoud use these security_opt seccomp:unconfined
  133. # settings to get WeKan working. See:
  134. # - https://github.com/wekan/wekan/issues/4585
  135. # - https://github.com/wekan/wekan/issues/4587
  136. #security_opt:
  137. # - seccomp:unconfined
  138. restart: always
  139. networks:
  140. - wekan-tier
  141. #-------------------------------------------------------------------------------------
  142. # ==== BUILD wekan-app DOCKER CONTAINER FROM SOURCE, if you uncomment these ====
  143. # ==== and use commands: docker-compose up -d --build
  144. #build:
  145. # context: .
  146. # dockerfile: Dockerfile
  147. #-------------------------------------------------------------------------------------
  148. ports:
  149. # Docker outsideport:insideport. Do not add anything extra here.
  150. # For example, if you want to have wekan on port 3001,
  151. # use 3001:8080 . Do not add any extra address etc here, that way it does not work.
  152. # remove port mapping if you use nginx reverse proxy, port 8080 is already exposed to wekan-tier network
  153. - 80:8080
  154. environment:
  155. #-----------------------------------------------------------------
  156. # ==== WRITEABLE PATH FOR FILE UPLOADS ====
  157. - WRITABLE_PATH=/data
  158. #-----------------------------------------------------------------
  159. # ==== AWS S3 FOR FILES ====
  160. # Any region. For example:
  161. # us-standard,us-west-1,us-west-2,
  162. # eu-west-1,eu-central-1,
  163. # ap-southeast-1,ap-northeast-1,sa-east-1
  164. #
  165. #- S3='{"s3":{"key": "xxx", "secret": "xxx", "bucket": "xxx", "region": "xxx"}}'
  166. #- S3_SECRET_FILE=/run/secrets/s3_secret
  167. #-----------------------------------------------------------------
  168. # ==== MONGO_URL ====
  169. - MONGO_URL=mongodb://wekandb:27017/wekan
  170. #- MONGO_URL=mongodb://username:password@wekandb:27017/wekan
  171. #- MONGO_PASSWORD_FILE=/run/secrets/mongo_password
  172. #---------------------------------------------------------------
  173. # ==== ROOT_URL SETTING ====
  174. # Change ROOT_URL to your real Wekan URL, for example:
  175. # If you have Caddy/Nginx/Apache providing SSL
  176. # - https://example.com
  177. # - https://boards.example.com
  178. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  179. # - https://example.com/wekan
  180. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  181. # - http://example.com
  182. # - http://boards.example.com
  183. # - http://192.168.1.100 <=== using at local LAN
  184. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  185. #---------------------------------------------------------------
  186. # ==== EMAIL SETTINGS ====
  187. # Email settings are only at MAIL_URL and MAIL_FROM.
  188. # Admin Panel has test button, but it's not used for settings.
  189. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  190. # For SSL in email, change smtp:// to smtps://
  191. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  192. # You can encode those characters for example at: https://www.urlencoder.org
  193. #- MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  194. - MAIL_URL=smtp://<mail_url>:25/?ignoreTLS=true&tls={rejectUnauthorized:false}
  195. - MAIL_FROM=Wekan Notifications <noreply.wekan@mydomain.com>
  196. # Currently MAIL_SERVICE is not in use.
  197. #- MAIL_SERVICE=Outlook365
  198. #- MAIL_SERVICE_USER=firstname.lastname@hotmail.com
  199. #- MAIL_SERVICE_PASSWORD=SecretPassword
  200. #- MAIL_SERVICE_PASSWORD_FILE=/run/secrets/mail_service_password
  201. #---------------------------------------------------------------
  202. # https://github.com/wekan/wekan/issues/3585#issuecomment-1021522132
  203. # Add more Node heap, this is done by default at Dockerfile:
  204. # - NODE_OPTIONS="--max_old_space_size=4096"
  205. # Add more stack, this is done at Dockerfile:
  206. # bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js"
  207. #---------------------------------------------------------------
  208. # ==== OPTIONAL: MONGO OPLOG SETTINGS =====
  209. # https://github.com/wekan/wekan-mongodb/issues/2#issuecomment-378343587
  210. # We've fixed our CPU usage problem today with an environment
  211. # change around Wekan. I wasn't aware during implementation
  212. # that if you're using more than 1 instance of Wekan
  213. # (or any MeteorJS based tool) you're supposed to set
  214. # MONGO_OPLOG_URL as an environment variable.
  215. # Without setting it, Meteor will perform a poll-and-diff
  216. # update of it's dataset. With it, Meteor will update from
  217. # the OPLOG. See here
  218. # https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908
  219. # After setting
  220. # MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  221. # the CPU usage for all Wekan instances dropped to an average
  222. # of less than 10% with only occasional spikes to high usage
  223. # (I guess when someone is doing a lot of work)
  224. # - MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  225. #---------------------------------------------------------------
  226. # ==== OPTIONAL: KADIRA PERFORMANCE MONITORING FOR METEOR ====
  227. # https://github.com/edemaine/kadira-compose
  228. # https://github.com/meteor/meteor-apm-agent
  229. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  230. #- APM_OPTIONS_ENDPOINT=http://<kadira-ip>:11011
  231. #- APM_APP_ID=
  232. #- APM_APP_SECRET=
  233. #---------------------------------------------------------------
  234. # ==== OPTIONAL: LOGS AND STATS ====
  235. # https://github.com/wekan/wekan/wiki/Logs
  236. #
  237. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  238. # https://github.com/wekan/wekan-logstash
  239. #
  240. # Statistics Python script for Wekan Dashboard
  241. # https://github.com/wekan/wekan-stats
  242. #
  243. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  244. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  245. # but there could be bug https://github.com/wekan/wekan/issues/1094
  246. #
  247. # There is Feature Request: Logging date and time of all activity with summary reports,
  248. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  249. #---------------------------------------------------------------
  250. # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ====
  251. #- RESULTS_PER_PAGE=20
  252. #---------------------------------------------------------------
  253. # ==== AFTER OIDC LOGIN, ADD USERS AUTOMATICALLY TO THIS BOARD ID ====
  254. # https://github.com/wekan/wekan/pull/5098
  255. #- DEFAULT_BOARD_ID=abcd1234
  256. #---------------------------------------------------------------
  257. # ==== WEKAN API AND EXPORT BOARD ====
  258. # Wekan Export Board works when WITH_API=true.
  259. # https://github.com/wekan/wekan/wiki/REST-API
  260. # https://github.com/wekan/wekan-gogs
  261. # If you disable Wekan API with false, Export Board does not work.
  262. - WITH_API=true
  263. #---------------------------------------------------------------
  264. # ==== PASSWORD BRUTE FORCE PROTECTION ====
  265. #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  266. #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  267. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  268. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  269. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  270. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  271. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  272. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  273. #---------------------------------------------------------------
  274. # ==== ACCOUNT OPTIONS ====
  275. # https://docs.meteor.com/api/accounts-multi.html#AccountsCommon-config
  276. # Defaults below. Uncomment to change. wekan/server/accounts-common.js
  277. # - ACCOUNTS_COMMON_LOGIN_EXPIRATION_IN_DAYS=90
  278. #---------------------------------------------------------------
  279. # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  280. # https://github.com/wekan/wekan/pull/2560
  281. - RICHER_CARD_COMMENT_EDITOR=false
  282. #---------------------------------------------------------------
  283. # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  284. # https://github.com/wekan/wekan/issues/2518
  285. - CARD_OPENED_WEBHOOK_ENABLED=false
  286. #---------------------------------------------------------------
  287. # ==== Allow configuration to validate uploaded attachments ====
  288. #-ATTACHMENTS_UPLOAD_EXTERNAL_PROGRAM=/usr/local/bin/avscan {file}
  289. #-ATTACHMENTS_UPLOAD_MIME_TYPES=image/*,text/*
  290. #-ATTACHMENTS_UPLOAD_MAX_SIZE=5000000
  291. #---------------------------------------------------------------
  292. # ==== Allow configuration to validate uploaded avatars ====
  293. #-AVATARS_UPLOAD_EXTERNAL_PROGRAM=/usr/local/bin/avscan {file}
  294. #-AVATARS_UPLOAD_MIME_TYPES=image/*
  295. #-AVATARS_UPLOAD_MAX_SIZE=500000
  296. #---------------------------------------------------------------
  297. # ==== Allow to shrink attached/pasted image ====
  298. # https://github.com/wekan/wekan/pull/2544
  299. #- MAX_IMAGE_PIXEL=1024
  300. #- IMAGE_COMPRESS_RATIO=80
  301. #---------------------------------------------------------------
  302. # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  303. # Number of days after a notification is read before we remove it.
  304. # Default: 2
  305. #- NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  306. #---------------------------------------------------------------
  307. # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  308. # https://github.com/wekan/wekan/pull/2541
  309. # Introduced a system env var BIGEVENTS_PATTERN default as "NONE",
  310. # so any activityType matches the pattern, system will send out
  311. # notifications to all board members no matter they are watching
  312. # or tracking the board or not. Owner of the wekan server can
  313. # disable the feature by setting this variable to "NONE" or
  314. # change the pattern to any valid regex. i.e. '|' delimited
  315. # activityType names.
  316. # a) Example
  317. #- BIGEVENTS_PATTERN=due
  318. # b) All
  319. #- BIGEVENTS_PATTERN=received|start|due|end
  320. # c) Disabled
  321. - BIGEVENTS_PATTERN=NONE
  322. #---------------------------------------------------------------
  323. # ==== EMAIL DUE DATE NOTIFICATION =====
  324. # https://github.com/wekan/wekan/pull/2536
  325. # System timelines will be showing any user modification for
  326. # dueat startat endat receivedat, also notification to
  327. # the watchers and if any card is due, about due or past due.
  328. #
  329. # Notify due days, default is None, 2 days before and on the event day
  330. #- NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2,0
  331. #
  332. # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  333. # If env variable has parsing error, use default. Notification sent to watchers.
  334. #- NOTIFY_DUE_AT_HOUR_OF_DAY=8
  335. #-----------------------------------------------------------------
  336. # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  337. # Default: 30000 ms = 30s
  338. #- EMAIL_NOTIFICATION_TIMEOUT=30000
  339. #-----------------------------------------------------------------
  340. # ==== CORS =====
  341. # CORS: Set Access-Control-Allow-Origin header.
  342. #- CORS=*
  343. # CORS_ALLOW_HEADERS: Set Access-Control-Allow-Headers header. "Authorization,Content-Type" is required for cross-origin use of the API.
  344. #- CORS_ALLOW_HEADERS=Authorization,Content-Type
  345. # CORS_EXPOSE_HEADERS: Set Access-Control-Expose-Headers header. This is not needed for typical CORS situations
  346. #- CORS_EXPOSE_HEADERS=*
  347. #-----------------------------------------------------------------
  348. # ==== MATOMO INTEGRATION ====
  349. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  350. # The address of the server where Matomo is hosted.
  351. #- MATOMO_ADDRESS=https://example.com/matomo
  352. # The value of the site ID given in Matomo server for Wekan
  353. #- MATOMO_SITE_ID=1
  354. # The option do not track which enables users to not be tracked by matomo
  355. #- MATOMO_DO_NOT_TRACK=true
  356. # The option that allows matomo to retrieve the username:
  357. #- MATOMO_WITH_USERNAME=true
  358. #-----------------------------------------------------------------
  359. # ==== BROWSER POLICY AND TRUSTED IFRAME URL ====
  360. # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  361. # Setting this to false is not recommended, it also disables all other browser policy protections
  362. # and allows all iframing etc. See wekan/server/policy.js
  363. - BROWSER_POLICY_ENABLED=true
  364. # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  365. #- TRUSTED_URL=https://intra.example.com
  366. #-----------------------------------------------------------------
  367. # ==== METRICS ALLOWED IP ADDRESSES ====
  368. # https://github.com/wekan/wekan/wiki/Metrics
  369. #- METRICS_ALLOWED_IP_ADDRESSES=192.168.0.100,192.168.0.200
  370. #-----------------------------------------------------------------
  371. # ==== OUTGOING WEBHOOKS ====
  372. # What to send to Outgoing Webhook, or leave out. If commented out the default values will be: cardId,listId,oldListId,boardId,comment,user,card,commentId,swimlaneId,customerField,customFieldValue
  373. #- WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  374. #-----------------------------------------------------------------
  375. # ==== Debug OIDC OAuth2 etc ====
  376. #- DEBUG=true
  377. #---------------------------------------------
  378. # ==== AUTOLOGIN WITH OIDC/OAUTH2 ====
  379. # https://github.com/wekan/wekan/wiki/autologin
  380. #- OIDC_REDIRECTION_ENABLED=true
  381. #-----------------------------------------------------------------
  382. # ==== OAUTH2 ORACLE on premise identity manager OIM ====
  383. #- ORACLE_OIM_ENABLED=true
  384. #-----------------------------------------------------------------
  385. # ==== OAUTH2 AZURE ====
  386. # https://github.com/wekan/wekan/wiki/Azure
  387. # 1) Register the application with Azure. Make sure you capture
  388. # the application ID as well as generate a secret key.
  389. # 2) Configure the environment variables. This differs slightly
  390. # by installation type, but make sure you have the following:
  391. #- OAUTH2_ENABLED=true
  392. # Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  393. #- OAUTH2_CA_CERT=ABCD1234
  394. # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  395. #- OAUTH2_ADFS_ENABLED=false
  396. # OAuth2 login style: popup or redirect.
  397. #- OAUTH2_LOGIN_STYLE=redirect
  398. # Application GUID captured during app registration:
  399. #- OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  400. # Secret key generated during app registration:
  401. #- OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  402. #- OAUTH2_SECRET_FILE=/run/secrets/oauth2_secret
  403. #- OAUTH2_SERVER_URL=https://login.microsoftonline.com/
  404. #- OAUTH2_AUTH_ENDPOINT=/oauth2/v2.0/authorize
  405. #- OAUTH2_USERINFO_ENDPOINT=https://graph.microsoft.com/oidc/userinfo
  406. #- OAUTH2_TOKEN_ENDPOINT=/oauth2/v2.0/token
  407. # The claim name you want to map to the unique ID field:
  408. #- OAUTH2_ID_MAP=email
  409. # The claim name you want to map to the username field:
  410. #- OAUTH2_USERNAME_MAP=email
  411. # The claim name you want to map to the full name field:
  412. #- OAUTH2_FULLNAME_MAP=name
  413. # The claim name you want to map to the email field:
  414. #- OAUTH2_EMAIL_MAP=email
  415. #-----------------------------------------------------------------
  416. # ==== OAUTH2 Nextcloud ====
  417. # 1) Register the application with Nextcloud: https://your.nextcloud/index.php/settings/admin/security
  418. # Make sure you capture the application ID as well as generate a secret key.
  419. # Use https://your.wekan/_oauth/oidc for the redirect URI.
  420. # 2) Configure the environment variables. This differs slightly
  421. # by installation type, but make sure you have the following:
  422. #- OAUTH2_ENABLED=true
  423. # OAuth2 login style: popup or redirect.
  424. #- OAUTH2_LOGIN_STYLE=redirect
  425. # Application GUID captured during app registration:
  426. #- OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  427. # Secret key generated during app registration:
  428. #- OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  429. #- OAUTH2_SECRET_FILE=/run/secrets/oauth2_secret
  430. #- OAUTH2_SERVER_URL=https://your-nextcloud.tld
  431. #- OAUTH2_AUTH_ENDPOINT=/index.php/apps/oauth2/authorize
  432. #- OAUTH2_USERINFO_ENDPOINT=/ocs/v2.php/cloud/user?format=json
  433. #- OAUTH2_TOKEN_ENDPOINT=/index.php/apps/oauth2/api/v1/token
  434. # The claim name you want to map to the unique ID field:
  435. #- OAUTH2_ID_MAP=id
  436. # The claim name you want to map to the username field:
  437. #- OAUTH2_USERNAME_MAP=id
  438. # The claim name you want to map to the full name field:
  439. #- OAUTH2_FULLNAME_MAP=display-name
  440. # The claim name you want to map to the email field:
  441. #- OAUTH2_EMAIL_MAP=email
  442. #-----------------------------------------------------------------
  443. # ==== OAUTH2 KEYCLOAK ====
  444. # https://github.com/wekan/wekan/wiki/Keycloak <== MAPPING INFO, REQUIRED
  445. #- OAUTH2_ENABLED=true
  446. # OAuth2 login style: popup or redirect.
  447. #- OAUTH2_LOGIN_STYLE=redirect
  448. #- OAUTH2_CLIENT_ID=<Keycloak create Client ID>
  449. #- OAUTH2_SERVER_URL=<Keycloak server name>/auth
  450. #- OAUTH2_AUTH_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/auth
  451. #- OAUTH2_USERINFO_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/userinfo
  452. #- OAUTH2_TOKEN_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/token
  453. #- OAUTH2_SECRET=<keycloak client secret>
  454. #- OAUTH2_SECRET_FILE=/run/secrets/oauth2_secret
  455. #-----------------------------------------------------------------
  456. # ==== OAUTH2 DOORKEEPER ====
  457. # https://github.com/wekan/wekan/issues/1874
  458. # https://github.com/wekan/wekan/wiki/OAuth2
  459. # Enable the OAuth2 connection
  460. #- OAUTH2_ENABLED=true
  461. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  462. # OAuth2 login style: popup or redirect.
  463. #- OAUTH2_LOGIN_STYLE=redirect
  464. # OAuth2 Client ID.
  465. #- OAUTH2_CLIENT_ID=abcde12345
  466. # OAuth2 Secret.
  467. #- OAUTH2_SECRET=54321abcde
  468. #- OAUTH2_SECRET_FILE=/run/secrets/oauth2_secret
  469. # OAuth2 Server URL.
  470. #- OAUTH2_SERVER_URL=https://chat.example.com
  471. # OAuth2 Authorization Endpoint.
  472. #- OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  473. # OAuth2 Userinfo Endpoint.
  474. #- OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  475. # OAuth2 Token Endpoint.
  476. #- OAUTH2_TOKEN_ENDPOINT=/oauth/token
  477. # OAUTH2 ID Token Whitelist Fields.
  478. #- OAUTH2_ID_TOKEN_WHITELIST_FIELDS=""
  479. # OAUTH2 Request Permissions.
  480. #- OAUTH2_REQUEST_PERMISSIONS=openid profile email
  481. # OAuth2 ID Mapping
  482. #- OAUTH2_ID_MAP=
  483. # OAuth2 Username Mapping
  484. #- OAUTH2_USERNAME_MAP=
  485. # OAuth2 Fullname Mapping
  486. #- OAUTH2_FULLNAME_MAP=
  487. # OAuth2 Email Mapping
  488. #- OAUTH2_EMAIL_MAP=
  489. #-----------------------------------------------------------------
  490. # ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
  491. # https://github.com/wekan/wekan/wiki/LDAP
  492. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  493. # Most settings work both on Snap and Docker below.
  494. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  495. #
  496. # The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  497. # (this is set properly in the Admin Panel, changing this item does not remove Password login option)
  498. #- DEFAULT_AUTHENTICATION_METHOD=ldap
  499. #
  500. # Enable or not the connection by the LDAP
  501. #- LDAP_ENABLE=true
  502. #
  503. # The port of the LDAP server
  504. #- LDAP_PORT=389
  505. #
  506. # The host server for the LDAP server
  507. #- LDAP_HOST=localhost
  508. #
  509. #-----------------------------------------------------------------
  510. # ==== LDAP AD Simple Auth ====
  511. #
  512. # Set to true, if you want to connect with Active Directory by Simple Authentication.
  513. # When using AD Simple Auth, LDAP_BASEDN is not needed.
  514. #
  515. # Example:
  516. #- LDAP_AD_SIMPLE_AUTH=true
  517. #
  518. # === LDAP User Authentication ===
  519. #
  520. # a) Option to login to the LDAP server with the user's own username and password, instead of
  521. # an administrator key. Default: false (use administrator key).
  522. #
  523. # b) When using AD Simple Auth, set to true, when login user is used for binding,
  524. # and LDAP_BASEDN is not needed.
  525. #
  526. # Example:
  527. #- LDAP_USER_AUTHENTICATION=true
  528. #
  529. # Which field is used to find the user for the user authentication. Default: uid.
  530. #- LDAP_USER_AUTHENTICATION_FIELD=uid
  531. #
  532. # === LDAP Default Domain ===
  533. #
  534. # a) In case AD SimpleAuth is configured, the default domain is appended to the given
  535. # loginname for creating the correct username for the bind request to AD.
  536. #
  537. # b) The default domain of the ldap it is used to create email if the field is not map
  538. # correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
  539. #
  540. # Example :
  541. #- LDAP_DEFAULT_DOMAIN=mydomain.com
  542. #
  543. #-----------------------------------------------------------------
  544. # ==== LDAP BASEDN Auth ====
  545. #
  546. # The base DN for the LDAP Tree
  547. #- LDAP_BASEDN=ou=user,dc=example,dc=org
  548. #
  549. #-----------------------------------------------------------------
  550. # Fallback on the default authentication method
  551. #- LDAP_LOGIN_FALLBACK=false
  552. #
  553. # Reconnect to the server if the connection is lost
  554. #- LDAP_RECONNECT=true
  555. #
  556. # Overall timeout, in milliseconds
  557. #- LDAP_TIMEOUT=10000
  558. #
  559. # Specifies the timeout for idle LDAP connections in milliseconds
  560. #- LDAP_IDLE_TIMEOUT=10000
  561. #
  562. # Connection timeout, in milliseconds
  563. #- LDAP_CONNECT_TIMEOUT=10000
  564. #
  565. # If the LDAP needs a user account to search
  566. #- LDAP_AUTHENTIFICATION=true
  567. #
  568. # The search user DN - You need quotes when you have spaces in parameters
  569. # 2 examples:
  570. #- LDAP_AUTHENTIFICATION_USERDN=CN=ldap admin,CN=users,DC=domainmatter,DC=lan
  571. #- LDAP_AUTHENTIFICATION_USERDN=CN=wekan_adm,OU=serviceaccounts,OU=admin,OU=prod,DC=mydomain,DC=com
  572. #
  573. # The password for the search user
  574. #- LDAP_AUTHENTIFICATION_PASSWORD=pwd
  575. #- LDAP_AUTHENTIFICATION_PASSWORD_FILE=/run/secrets/ldap_auth_password
  576. #
  577. # Enable logs for the module
  578. #- LDAP_LOG_ENABLED=true
  579. #
  580. # If the sync of the users should be done in the background
  581. #- LDAP_BACKGROUND_SYNC=false
  582. #
  583. # LDAP_BACKGROUND_SYNC_INTERVAL : At which interval does the background task sync in milliseconds
  584. # The format must be as specified in:
  585. # https://bunkat.github.io/later/parsers.html#text
  586. #- LDAP_BACKGROUND_SYNC_INTERVAL=every 1 hours
  587. # At which interval does the background task sync in milliseconds.
  588. # Leave this unset, so it uses default, and does not crash.
  589. # https://github.com/wekan/wekan/issues/2354#issuecomment-515305722
  590. - LDAP_BACKGROUND_SYNC_INTERVAL=''
  591. #
  592. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  593. #
  594. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  595. #
  596. # If using LDAPS: LDAP_ENCRYPTION=ssl
  597. #- LDAP_ENCRYPTION=false
  598. #
  599. # The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  600. #- LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+G2FIdAgIC...-----END CERTIFICATE-----
  601. #
  602. # Reject Unauthorized Certificate
  603. #- LDAP_REJECT_UNAUTHORIZED=false
  604. #
  605. # Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  606. #- LDAP_USER_SEARCH_FILTER=
  607. #
  608. # base (search only in the provided DN), one (search only in the provided DN and one level deep), or sub (search the whole subtree)
  609. #- LDAP_USER_SEARCH_SCOPE=one
  610. #
  611. # Which field is used to find the user, like uid / sAMAccountName
  612. #- LDAP_USER_SEARCH_FIELD=sAMAccountName
  613. #
  614. # Used for pagination (0=unlimited)
  615. #- LDAP_SEARCH_PAGE_SIZE=0
  616. #
  617. # The limit number of entries (0=unlimited)
  618. #- LDAP_SEARCH_SIZE_LIMIT=0
  619. #
  620. # Enable group filtering. Note the authenticated ldap user must be able to query all relevant group data with own login data from ldap.
  621. #- LDAP_GROUP_FILTER_ENABLE=false
  622. #
  623. # The object class for filtering. Example: group
  624. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  625. #
  626. # The attribute of a group identifying it. Example: cn
  627. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  628. #
  629. # The attribute inside a group object listing its members. Example: member
  630. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  631. #
  632. # The format of the value of LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE. Example: 'dn' if the users dn is saved as value into the attribute.
  633. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  634. #
  635. # The group name (id) that matches all users.
  636. #- LDAP_GROUP_FILTER_GROUP_NAME=
  637. #
  638. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier). Example: guid
  639. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  640. #
  641. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  642. #- LDAP_UTF8_NAMES_SLUGIFY=true
  643. #
  644. # LDAP_USERNAME_FIELD : Which field contains the ldap username. username / sAMAccountName
  645. #- LDAP_USERNAME_FIELD=sAMAccountName
  646. #
  647. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname. fullname / sAMAccountName
  648. #- LDAP_FULLNAME_FIELD=fullname
  649. #
  650. #- LDAP_MERGE_EXISTING_USERS=false
  651. #
  652. # Allow existing account matching by e-mail address when username does not match
  653. #- LDAP_EMAIL_MATCH_ENABLE=true
  654. #
  655. # LDAP_EMAIL_MATCH_REQUIRE : require existing account matching by e-mail address when username does match
  656. #- LDAP_EMAIL_MATCH_REQUIRE=true
  657. #
  658. # LDAP_EMAIL_MATCH_VERIFIED : require existing account email address to be verified for matching
  659. #- LDAP_EMAIL_MATCH_VERIFIED=true
  660. #
  661. # LDAP_EMAIL_FIELD : which field contains the LDAP e-mail address
  662. #- LDAP_EMAIL_FIELD=mail
  663. #-----------------------------------------------------------------
  664. #- LDAP_SYNC_USER_DATA=false
  665. #
  666. #- LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  667. #
  668. #- LDAP_SYNC_GROUP_ROLES=
  669. #
  670. # The default domain of the ldap it is used to create email if the field is not map correctly
  671. # with the LDAP_SYNC_USER_DATA_FIELDMAP is defined in setting LDAP_DEFAULT_DOMAIN above.
  672. #
  673. # Enable/Disable syncing of admin status based on ldap groups:
  674. #- LDAP_SYNC_ADMIN_STATUS=true
  675. #
  676. # Comma separated list of admin group names to sync.
  677. #- LDAP_SYNC_ADMIN_GROUPS=group1,group2
  678. #---------------------------------------------------------------------
  679. # Login to LDAP automatically with HTTP header.
  680. # In below example for siteminder, at right side of = is header name.
  681. #- HEADER_LOGIN_ID=HEADERUID
  682. #- HEADER_LOGIN_FIRSTNAME=HEADERFIRSTNAME
  683. #- HEADER_LOGIN_LASTNAME=HEADERLASTNAME
  684. #- HEADER_LOGIN_EMAIL=HEADEREMAILADDRESS
  685. #---------------------------------------------------------------------
  686. # ==== LOGOUT TIMER, probably does not work yet ====
  687. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  688. # example : LOGOUT_WITH_TIMER=true
  689. #- LOGOUT_WITH_TIMER=
  690. #
  691. # LOGOUT_IN : The number of days
  692. # example : LOGOUT_IN=1
  693. #- LOGOUT_IN=
  694. #
  695. # LOGOUT_ON_HOURS : The number of hours
  696. # example : LOGOUT_ON_HOURS=9
  697. #- LOGOUT_ON_HOURS=
  698. #
  699. # LOGOUT_ON_MINUTES : The number of minutes
  700. # example : LOGOUT_ON_MINUTES=55
  701. #- LOGOUT_ON_MINUTES=
  702. #-------------------------------------------------------------------
  703. # Hide password login form
  704. # - PASSWORD_LOGIN_ENABLED=true
  705. #-------------------------------------------------------------------
  706. #- CAS_ENABLED=true
  707. #- CAS_BASE_URL=https://cas.example.com/cas
  708. #- CAS_LOGIN_URL=https://cas.example.com/login
  709. #- CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  710. #---------------------------------------------------------------------
  711. #- SAML_ENABLED=true
  712. #- SAML_PROVIDER=
  713. #- SAML_ENTRYPOINT=
  714. #- SAML_ISSUER=
  715. #- SAML_CERT=
  716. #- SAML_IDPSLO_REDIRECTURL=
  717. #- SAML_PRIVATE_KEYFILE=
  718. #- SAML_PUBLIC_CERTFILE=
  719. #- SAML_IDENTIFIER_FORMAT=
  720. #- SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  721. #- SAML_ATTRIBUTES=
  722. #---------------------------------------------------------------------
  723. # Wait spinner to use
  724. # - WAIT_SPINNER=Bounce
  725. #---------------------------------------------------------------------
  726. depends_on:
  727. - wekandb
  728. volumes:
  729. - /etc/localtime:/etc/localtime:ro
  730. - wekan-files:/data:rw
  731. secrets:
  732. - ldap_auth_password
  733. - oauth2_secret
  734. - mail_service_password
  735. - mongo_password
  736. - s3_secret
  737. #---------------------------------------------------------------------------------
  738. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  739. # When using Wekan both at office LAN and remote VPN:
  740. # 1) Have above Wekan docker container config with LAN IP address
  741. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  742. # before above depends_on: part:
  743. #
  744. # wekan:
  745. # #-------------------------------------------------------------------------------------
  746. # # ==== MONGODB AND METEOR VERSION ====
  747. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  748. #
  749. #
  750. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  751. # address.
  752. # 3) This way both Wekan containers can use same MongoDB database
  753. # and see the same Wekan boards.
  754. # 4) You could also add 3rd Wekan container for 3rd network etc.
  755. # EXAMPLE:
  756. # wekan2:
  757. # ....COPY CONFIG FROM ABOVE TO HERE...
  758. # environment:
  759. # - ROOT_URL='http://10.10.10.10'
  760. # ...COPY CONFIG FROM ABOVE TO HERE...
  761. #---------------------------------------------------------------------------------
  762. # OPTIONAL NGINX CONFIG FOR REVERSE PROXY
  763. # nginx:
  764. # image: nginx
  765. # container_name: nginx
  766. # restart: always
  767. # networks:
  768. # - wekan-tier
  769. # depends_on:
  770. # - wekan
  771. # ports:
  772. # - 80:80
  773. # - 443:443
  774. # volumes:
  775. # - ./nginx/ssl:/etc/nginx/ssl/:ro
  776. # - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
  777. ## Alternative volume config:
  778. ## volumes:
  779. ## - ./nginx/nginx.conf:/etc/nginx/conf.d/default.conf:ro
  780. ## - ./nginx/ssl/ssl.conf:/etc/nginx/conf.d/ssl/ssl.conf:ro
  781. ## - ./nginx/ssl/testvm-ehu.crt:/etc/nginx/conf.d/ssl/certs/mycert.crt:ro
  782. ## - ./nginx/ssl/testvm-ehu.key:/etc/nginx/conf.d/ssl/certs/mykey.key:ro
  783. ## - ./nginx/ssl/pphrase:/etc/nginx/conf.d/ssl/pphrase:ro
  784. volumes:
  785. wekan-files:
  786. driver: local
  787. wekan-db:
  788. driver: local
  789. wekan-db-dump:
  790. driver: local
  791. networks:
  792. wekan-tier:
  793. driver: bridge
  794. # Docker Compose Secrets
  795. # Create secret files on the host system before running docker-compose up
  796. # Example: echo "your_password_here" > ldap_auth_password.txt
  797. # Then use: docker-compose up -d
  798. secrets:
  799. ldap_auth_password:
  800. file: ./secrets/ldap_auth_password.txt
  801. oauth2_secret:
  802. file: ./secrets/oauth2_secret.txt
  803. mail_service_password:
  804. file: ./secrets/mail_service_password.txt
  805. mongo_password:
  806. file: ./secrets/mongo_password.txt
  807. s3_secret:
  808. file: ./secrets/s3_secret.txt