docker-compose.yml 31 KB

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