docker-compose.yml 30 KB

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