docker-compose.yml 31 KB

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