docker-compose.yml 28 KB

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