docker-compose.yml 33 KB

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