docker-compose.yml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  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. # 1) Stop Wekan:
  12. # docker-compose stop
  13. # 2) Download new version:
  14. # docker-compose pull wekan
  15. # 3) If you have more networks for VPN etc as described at bottom of
  16. # this config, download for them too:
  17. # docker-compose pull wekan2
  18. # 4) Start Wekan:
  19. # docker-compose start
  20. #----------------------------------------------------------------------------------
  21. # ==== OPTIONAL: DEDICATED DOCKER USER ====
  22. # 1) Optionally create a dedicated user for Wekan, for example:
  23. # sudo useradd -d /home/wekan -m -s /bin/bash wekan
  24. # 2) Add this user to the docker group, then logout+login or reboot:
  25. # sudo usermod -aG docker wekan
  26. # 3) Then login as user wekan.
  27. # 4) Create this file /home/wekan/docker-compose.yml with your modifications.
  28. #----------------------------------------------------------------------------------
  29. # ==== RUN DOCKER AS SERVICE ====
  30. # 1a) Running Docker as service, on Systemd like Debian 9, Ubuntu 16.04, CentOS 7:
  31. # sudo systemctl enable docker
  32. # sudo systemctl start docker
  33. # 1b) Running Docker as service, on init.d like Debian 8, Ubuntu 14.04, CentOS 6:
  34. # sudo update-rc.d docker defaults
  35. # sudo service docker start
  36. # ----------------------------------------------------------------------------------
  37. # ==== USAGE OF THIS docker-compose.yml ====
  38. # 1) For seeing does Wekan work, try this and check with your webbroser:
  39. # docker-compose up
  40. # 2) Stop Wekan and start Wekan in background:
  41. # docker-compose stop
  42. # docker-compose up -d
  43. # 3) See running Docker containers:
  44. # docker ps
  45. # 4) Stop Docker containers:
  46. # docker-compose stop
  47. # ----------------------------------------------------------------------------------
  48. # ===== INSIDE DOCKER CONTAINERS, AND BACKUP/RESTORE ====
  49. # https://github.com/wekan/wekan/wiki/Backup
  50. # If really necessary, repair MongoDB: https://github.com/wekan/wekan-mongodb/issues/6#issuecomment-424004116
  51. # 1) Going inside containers:
  52. # a) Wekan app, does not contain data
  53. # docker exec -it wekan-app bash
  54. # b) MongoDB, contains all data
  55. # docker exec -it wekan-db bash
  56. # 2) Copying database to outside of container:
  57. # docker exec -it wekan-db bash
  58. # cd /data
  59. # mongodump
  60. # exit
  61. # docker cp wekan-db:/data/dump .
  62. # 3) Restoring database
  63. # # 1) Stop wekan
  64. # docker stop wekan-app
  65. # # 2) Go inside database container
  66. # docker exec -it wekan-db bash
  67. # # 3) and data directory
  68. # cd /data
  69. # # 4) Remove previos dump
  70. # rm -rf dump
  71. # # 5) Exit db container
  72. # exit
  73. # # 6) Copy dump to inside docker container
  74. # docker cp dump wekan-db:/data/
  75. # # 7) Go inside database container
  76. # docker exec -it wekan-db bash
  77. # # 8) and data directory
  78. # cd /data
  79. # # 9) Restore
  80. # mongorestore --drop
  81. # # 10) Exit db container
  82. # exit
  83. # # 11) Start wekan
  84. # docker start wekan-app
  85. #-------------------------------------------------------------------------
  86. services:
  87. torodb-stampede:
  88. image: torodb/stampede:latest
  89. networks:
  90. - wekan-tier
  91. links:
  92. - postgres
  93. - mongodb
  94. environment:
  95. - POSTGRES_PASSWORD
  96. - TORODB_SETUP=true
  97. - TORODB_SYNC_SOURCE=mongodb:27017
  98. - TORODB_BACKEND_HOST=postgres
  99. - TORODB_BACKEND_PORT=5432
  100. - TORODB_BACKEND_DATABASE=wekan
  101. - TORODB_BACKEND_USER=wekan
  102. - TORODB_BACKEND_PASSWORD=wekan
  103. - DEBUG
  104. postgres:
  105. image: postgres:9.6
  106. networks:
  107. - wekan-tier
  108. environment:
  109. - POSTGRES_PASSWORD
  110. ports:
  111. - "5432:5432"
  112. mongodb:
  113. image: mongo:3.2
  114. networks:
  115. - wekan-tier
  116. ports:
  117. - "27017:27017"
  118. entrypoint:
  119. - /bin/bash
  120. - "-c"
  121. - mongo --nodb --eval '
  122. var db;
  123. while (!db) {
  124. try {
  125. db = new Mongo("mongodb:27017").getDB("local");
  126. } catch(ex) {}
  127. sleep(3000);
  128. };
  129. rs.initiate({_id:"rs1",members:[{_id:0,host:"mongodb:27017"}]});
  130. ' 1>/dev/null 2>&1 &
  131. mongod --replSet rs1
  132. wekan:
  133. image: quay.io/wekan/wekan
  134. container_name: wekan-app
  135. restart: always
  136. networks:
  137. - wekan-tier
  138. ports:
  139. # Docker outsideport:insideport. Do not add anything extra here.
  140. # For example, if you want to have wekan on port 3001,
  141. # use 3001:8080 . Do not add any extra address etc here, that way it does not work.
  142. - 80:8080
  143. environment:
  144. - MONGO_URL=mongodb://mongodb:27017/wekan
  145. #---------------------------------------------------------------
  146. # ==== ROOT_URL SETTING ====
  147. # Change ROOT_URL to your real Wekan URL, for example:
  148. # If you have Caddy/Nginx/Apache providing SSL
  149. # - https://example.com
  150. # - https://boards.example.com
  151. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  152. # - https://example.com/wekan
  153. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  154. # - http://example.com
  155. # - http://boards.example.com
  156. # - http://192.168.1.100 <=== using at local LAN
  157. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  158. # ==== EMAIL SETTINGS ====
  159. # Email settings are required in both MAIL_URL and Admin Panel,
  160. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  161. # For SSL in email, change smtp:// to smtps://
  162. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  163. # You can encode those characters for example at: https://www.urlencoder.org
  164. - MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  165. - MAIL_FROM='Example Wekan Support <support@example.com>'
  166. #---------------------------------------------------------------
  167. # ==== OPTIONAL: MONGO OPLOG SETTINGS =====
  168. # https://github.com/wekan/wekan-mongodb/issues/2#issuecomment-378343587
  169. # We've fixed our CPU usage problem today with an environment
  170. # change around Wekan. I wasn't aware during implementation
  171. # that if you're using more than 1 instance of Wekan
  172. # (or any MeteorJS based tool) you're supposed to set
  173. # MONGO_OPLOG_URL as an environment variable.
  174. # Without setting it, Meteor will perform a poll-and-diff
  175. # update of it's dataset. With it, Meteor will update from
  176. # the OPLOG. See here
  177. # https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908
  178. # After setting
  179. # MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  180. # the CPU usage for all Wekan instances dropped to an average
  181. # of less than 10% with only occasional spikes to high usage
  182. # (I guess when someone is doing a lot of work)
  183. # - MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  184. #---------------------------------------------------------------
  185. # ==== OPTIONAL: KADIRA PERFORMANCE MONITORING FOR METEOR ====
  186. # https://github.com/smeijer/kadira
  187. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  188. # - export KADIRA_OPTIONS_ENDPOINT=http://127.0.0.1:11011
  189. #---------------------------------------------------------------
  190. # ==== OPTIONAL: LOGS AND STATS ====
  191. # https://github.com/wekan/wekan/wiki/Logs
  192. #
  193. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  194. # https://github.com/wekan/wekan-logstash
  195. #
  196. # Statistics Python script for Wekan Dashboard
  197. # https://github.com/wekan/wekan-stats
  198. #
  199. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  200. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  201. # but there could be bug https://github.com/wekan/wekan/issues/1094
  202. #
  203. # There is Feature Request: Logging date and time of all activity with summary reports,
  204. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  205. #---------------------------------------------------------------
  206. # ==== WEKAN API AND EXPORT BOARD ====
  207. # Wekan Export Board works when WITH_API=true.
  208. # https://github.com/wekan/wekan/wiki/REST-API
  209. # https://github.com/wekan/wekan-gogs
  210. # If you disable Wekan API with false, Export Board does not work.
  211. - WITH_API=true
  212. #---------------------------------------------------------------
  213. # ==== PASSWORD BRUTE FORCE PROTECTION ====
  214. #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  215. #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  216. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  217. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  218. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  219. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  220. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  221. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  222. #---------------------------------------------------------------
  223. # ==== STORE ATTACHMENT ON SERVER FILESYSTEM INSTEAD OF MONGODB ====
  224. # https://github.com/wekan/wekan/pull/2603
  225. #- ATTACHMENTS_STORE_PATH = <pathname> # pathname can be relative or fullpath
  226. #---------------------------------------------------------------
  227. # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  228. # https://github.com/wekan/wekan/pull/2560
  229. - RICHER_CARD_COMMENT_EDITOR=false
  230. #---------------------------------------------------------------
  231. # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  232. # https://github.com/wekan/wekan/issues/2518
  233. - CARD_OPENED_WEBHOOK_ENABLED=false
  234. #---------------------------------------------------------------
  235. # ==== Allow to shrink attached/pasted image ====
  236. # https://github.com/wekan/wekan/pull/2544
  237. #-MAX_IMAGE_PIXEL=1024
  238. #-IMAGE_COMPRESS_RATIO=80
  239. #---------------------------------------------------------------
  240. # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  241. # Number of days after a notification is read before we remove it.
  242. # Default: 2
  243. #- NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  244. #---------------------------------------------------------------
  245. # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  246. # https://github.com/wekan/wekan/pull/2541
  247. # Introduced a system env var BIGEVENTS_PATTERN default as "NONE",
  248. # so any activityType matches the pattern, system will send out
  249. # notifications to all board members no matter they are watching
  250. # or tracking the board or not. Owner of the wekan server can
  251. # disable the feature by setting this variable to "NONE" or
  252. # change the pattern to any valid regex. i.e. '|' delimited
  253. # activityType names.
  254. # a) Example
  255. #- BIGEVENTS_PATTERN=due
  256. # b) All
  257. #- BIGEVENTS_PATTERN=received|start|due|end
  258. # c) Disabled
  259. - BIGEVENTS_PATTERN=NONE
  260. #---------------------------------------------------------------
  261. # ==== EMAIL DUE DATE NOTIFICATION =====
  262. # https://github.com/wekan/wekan/pull/2536
  263. # System timelines will be showing any user modification for
  264. # dueat startat endat receivedat, also notification to
  265. # the watchers and if any card is due, about due or past due.
  266. #
  267. # Notify due days, default 2 days before and after. 0 = due notifications disabled. Default: 2
  268. #- NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2
  269. #
  270. # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  271. # If env variable has parsing error, use default. Notification sent to watchers.
  272. #- NOTIFY_DUE_AT_HOUR_OF_DAY=8
  273. #-----------------------------------------------------------------
  274. # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  275. # Defaut: 30000 ms = 30s
  276. #- EMAIL_NOTIFICATION_TIMEOUT=30000
  277. #-----------------------------------------------------------------
  278. # ==== CORS =====
  279. # CORS: Set Access-Control-Allow-Origin header. Example: *
  280. #- CORS=*
  281. #-----------------------------------------------------------------
  282. # ==== MATOMO INTEGRATION ====
  283. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  284. # The address of the server where Matomo is hosted.
  285. # example: - MATOMO_ADDRESS=https://example.com/matomo
  286. #- MATOMO_ADDRESS=
  287. # The value of the site ID given in Matomo server for Wekan
  288. # example: - MATOMO_SITE_ID=12345
  289. #- MATOMO_SITE_ID=
  290. # The option do not track which enables users to not be tracked by matomo
  291. # example: - MATOMO_DO_NOT_TRACK=false
  292. #- MATOMO_DO_NOT_TRACK=
  293. # The option that allows matomo to retrieve the username:
  294. # example: MATOMO_WITH_USERNAME=true
  295. #- MATOMO_WITH_USERNAME=false
  296. #-----------------------------------------------------------------
  297. # ==== BROWSER POLICY AND TRUSTED IFRAME URL ====
  298. # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  299. # Setting this to false is not recommended, it also disables all other browser policy protections
  300. # and allows all iframing etc. See wekan/server/policy.js
  301. - BROWSER_POLICY_ENABLED=true
  302. # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  303. #- TRUSTED_URL=
  304. #-----------------------------------------------------------------
  305. # ==== OUTGOING WEBHOOKS ====
  306. # What to send to Outgoing Webhook, or leave out. Example, that includes all that are default: cardId,listId,oldListId,boardId,comment,user,card,commentId .
  307. # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  308. #- WEBHOOKS_ATTRIBUTES=
  309. #-----------------------------------------------------------------
  310. # ==== OAUTH2 ONLY WITH OIDC AND DOORKEEPER AS INDENTITY PROVIDER
  311. # https://github.com/wekan/wekan/issues/1874
  312. # https://github.com/wekan/wekan/wiki/OAuth2
  313. # Enable the OAuth2 connection
  314. # example: OAUTH2_ENABLED=true
  315. #- OAUTH2_ENABLED=false
  316. # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  317. #- OAUTH2_ADFS_ENABLED=false
  318. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  319. # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  320. # example: OAUTH2_CLIENT_ID=abcde12345
  321. #- OAUTH2_CLIENT_ID=
  322. # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  323. # example: OAUTH2_SECRET=54321abcde
  324. #- OAUTH2_SECRET=
  325. # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  326. # example: OAUTH2_SERVER_URL=https://chat.example.com
  327. #- OAUTH2_SERVER_URL=
  328. # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  329. # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  330. #- OAUTH2_AUTH_ENDPOINT=
  331. # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  332. # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  333. #- OAUTH2_USERINFO_ENDPOINT=
  334. # OAuth2 Token Endpoint. Example: /oauth/token
  335. # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  336. #- OAUTH2_TOKEN_ENDPOINT=
  337. #-----------------------------------------------------------------
  338. # ==== LDAP ====
  339. # https://github.com/wekan/wekan/wiki/LDAP
  340. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  341. # Most settings work both on Snap and Docker below.
  342. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  343. #
  344. # DEFAULT_AUTHENTICATION_METHOD : The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  345. # example : DEFAULT_AUTHENTICATION_METHOD=ldap
  346. #- DEFAULT_AUTHENTICATION_METHOD=
  347. #
  348. # LDAP_ENABLE : Enable or not the connection by the LDAP
  349. # example : LDAP_ENABLE=true
  350. #- LDAP_ENABLE=false
  351. #
  352. # LDAP_PORT : The port of the LDAP server
  353. # example : LDAP_PORT=389
  354. #- LDAP_PORT=389
  355. #
  356. # LDAP_HOST : The host server for the LDAP server
  357. # example : LDAP_HOST=localhost
  358. #- LDAP_HOST=
  359. #
  360. # LDAP_BASEDN : The base DN for the LDAP Tree
  361. # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  362. #- LDAP_BASEDN=
  363. #
  364. # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  365. # example : LDAP_LOGIN_FALLBACK=true
  366. #- LDAP_LOGIN_FALLBACK=false
  367. #
  368. # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  369. # example : LDAP_RECONNECT=false
  370. #- LDAP_RECONNECT=true
  371. #
  372. # LDAP_TIMEOUT : Overall timeout, in milliseconds
  373. # example : LDAP_TIMEOUT=12345
  374. #- LDAP_TIMEOUT=10000
  375. #
  376. # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  377. # example : LDAP_IDLE_TIMEOUT=12345
  378. #- LDAP_IDLE_TIMEOUT=10000
  379. #
  380. # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  381. # example : LDAP_CONNECT_TIMEOUT=12345
  382. #- LDAP_CONNECT_TIMEOUT=10000
  383. #
  384. # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  385. # example : LDAP_AUTHENTIFICATION=true
  386. #- LDAP_AUTHENTIFICATION=false
  387. #
  388. # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  389. # example : LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  390. #- LDAP_AUTHENTIFICATION_USERDN=
  391. #
  392. # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  393. # example : AUTHENTIFICATION_PASSWORD=admin
  394. #- LDAP_AUTHENTIFICATION_PASSWORD=
  395. #
  396. # LDAP_LOG_ENABLED : Enable logs for the module
  397. # example : LDAP_LOG_ENABLED=true
  398. #- LDAP_LOG_ENABLED=false
  399. #
  400. # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  401. # example : LDAP_BACKGROUND_SYNC=true
  402. #- LDAP_BACKGROUND_SYNC=false
  403. #
  404. # At which interval does the background task sync.
  405. # The format must be as specified in:
  406. # https://bunkat.github.io/later/parsers.html#text
  407. #- LDAP_BACKGROUND_SYNC_INTERVAL='every 1 hour'
  408. #
  409. # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  410. # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  411. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  412. #
  413. # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  414. # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  415. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  416. #
  417. # LDAP_ENCRYPTION : If using LDAPS
  418. # example : LDAP_ENCRYPTION=ssl
  419. #- LDAP_ENCRYPTION=false
  420. #
  421. # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  422. # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  423. #- LDAP_CA_CERT=
  424. #
  425. # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  426. # example : LDAP_REJECT_UNAUTHORIZED=true
  427. #- LDAP_REJECT_UNAUTHORIZED=false
  428. #
  429. # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  430. # example : LDAP_USER_SEARCH_FILTER=
  431. #- LDAP_USER_SEARCH_FILTER=
  432. #
  433. # LDAP_USER_SEARCH_SCOPE : base (search only in the provided DN), one (search only in the provided DN and one level deep), or sub (search the whole subtree)
  434. # example : LDAP_USER_SEARCH_SCOPE=one
  435. #- LDAP_USER_SEARCH_SCOPE=
  436. #
  437. # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  438. # example : LDAP_USER_SEARCH_FIELD=uid
  439. #- LDAP_USER_SEARCH_FIELD=
  440. #
  441. # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  442. # example : LDAP_SEARCH_PAGE_SIZE=12345
  443. #- LDAP_SEARCH_PAGE_SIZE=0
  444. #
  445. # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  446. # example : LDAP_SEARCH_SIZE_LIMIT=12345
  447. #- LDAP_SEARCH_SIZE_LIMIT=0
  448. #
  449. # LDAP_GROUP_FILTER_ENABLE : Enable group filtering. Note the authenticated ldap user must be able to query all relevant group data with own login data from ldap
  450. # example : LDAP_GROUP_FILTER_ENABLE=true
  451. #- LDAP_GROUP_FILTER_ENABLE=false
  452. #
  453. # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  454. # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  455. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  456. #
  457. # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE : The attribute of a group identifying it
  458. # example : LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=cn
  459. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  460. #
  461. # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE : The attribute inside a group object listing its members
  462. # example : member
  463. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  464. #
  465. # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT : The format of the value of LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE
  466. # example : dn
  467. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  468. #
  469. # LDAP_GROUP_FILTER_GROUP_NAME : The group name (id) that matches all users
  470. # example : wekan_users
  471. #- LDAP_GROUP_FILTER_GROUP_NAME=
  472. #
  473. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  474. # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  475. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  476. #
  477. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  478. # example : LDAP_UTF8_NAMES_SLUGIFY=false
  479. #- LDAP_UTF8_NAMES_SLUGIFY=true
  480. #
  481. # LDAP_USERNAME_FIELD : Which field contains the ldap username
  482. # example : LDAP_USERNAME_FIELD=username
  483. #- LDAP_USERNAME_FIELD=
  484. #
  485. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname
  486. # example : LDAP_FULLNAME_FIELD=fullname
  487. #- LDAP_FULLNAME_FIELD=
  488. #
  489. # LDAP_MERGE_EXISTING_USERS :
  490. # example : LDAP_MERGE_EXISTING_USERS=true
  491. #- LDAP_MERGE_EXISTING_USERS=false
  492. #-----------------------------------------------------------------
  493. # LDAP_SYNC_USER_DATA :
  494. # example : LDAP_SYNC_USER_DATA=true
  495. #- LDAP_SYNC_USER_DATA=false
  496. #
  497. # LDAP_SYNC_USER_DATA_FIELDMAP :
  498. # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  499. #- LDAP_SYNC_USER_DATA_FIELDMAP=
  500. #
  501. # LDAP_SYNC_GROUP_ROLES :
  502. # example :
  503. #- LDAP_SYNC_GROUP_ROLES=
  504. #
  505. # LDAP_DEFAULT_DOMAIN : 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
  506. # example :
  507. #- LDAP_DEFAULT_DOMAIN=
  508. #---------------------------------------------------------------------
  509. # ==== LOGOUT TIMER, probably does not work yet ====
  510. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  511. # example : LOGOUT_WITH_TIMER=true
  512. #- LOGOUT_WITH_TIMER=
  513. #
  514. # LOGOUT_IN : The number of days
  515. # example : LOGOUT_IN=1
  516. #- LOGOUT_IN=
  517. #
  518. # LOGOUT_ON_HOURS : The number of hours
  519. # example : LOGOUT_ON_HOURS=9
  520. #- LOGOUT_ON_HOURS=
  521. #
  522. # LOGOUT_ON_MINUTES : The number of minutes
  523. # example : LOGOUT_ON_MINUTES=55
  524. #- LOGOUT_ON_MINUTES=
  525. #---------------------------------------------------------------------
  526. # PASSWORD_LOGIN_ENABLED : Enable or not the password login form.
  527. # example: PASSWORD_LOGIN_ENABLED=false
  528. # - PASSWORD_LOGIN_ENABLED
  529. #-------------------------------------------------------------------
  530. #- CAS_ENABLED=true
  531. #- CAS_BASE_URL=https://cas.example.com/cas
  532. #- CAS_LOGIN_URL=https://cas.example.com/login
  533. #- CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  534. #---------------------------------------------------------------------
  535. #- SAML_ENABLED=true
  536. #- SAML_PROVIDER=
  537. #- SAML_ENTRYPOINT=
  538. #- SAML_ISSUER=
  539. #- SAML_CERT=
  540. #- SAML_IDPSLO_REDIRECTURL=
  541. #- SAML_PRIVATE_KEYFILE=
  542. #- SAML_PUBLIC_CERTFILE=
  543. #- SAML_IDENTIFIER_FORMAT=
  544. #- SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  545. #- SAML_ATTRIBUTES=
  546. #---------------------------------------------------------------------
  547. depends_on:
  548. - mongodb
  549. #---------------------------------------------------------------------------------
  550. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  551. # When using Wekan both at office LAN and remote VPN:
  552. # 1) Have above Wekan docker container config with LAN IP address
  553. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  554. # before above depends_on: part:
  555. #
  556. # wekan:
  557. # #-------------------------------------------------------------------------------------
  558. # # ==== MONGODB AND METEOR VERSION ====
  559. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  560. #
  561. #
  562. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  563. # address.
  564. # 3) This way both Wekan containers can use same MongoDB database
  565. # and see the same Wekan boards.
  566. # 4) You could also add 3rd Wekan container for 3rd network etc.
  567. # EXAMPLE:
  568. # wekan2:
  569. # ....COPY CONFIG FROM ABOVE TO HERE...
  570. # environment:
  571. # - ROOT_URL='http://10.10.10.10'
  572. # ...COPY CONFIG FROM ABOVE TO HERE...
  573. #---------------------------------------------------------------------------------
  574. volumes:
  575. mongodb:
  576. driver: local
  577. mongodb-dump:
  578. driver: local
  579. networks:
  580. wekan-tier:
  581. driver: bridge