docker-compose.yml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
  1. version: '2'
  2. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  3. #---------------------------------------------------------------------------------------------------------
  4. # ==== CREATING USERS AND LOGGING IN TO WEKAN ====
  5. # https://github.com/wekan/wekan/wiki/Adding-users
  6. #---------------------------------------------------------------------------------------------------------
  7. # ==== FORGOT PASSWORD ====
  8. # https://github.com/wekan/wekan/wiki/Forgot-Password
  9. #---------------------------------------------------------------------------------------------------------
  10. # ==== Upgrading Wekan to new version =====
  11. # NOTE: MongoDB has changed from 3.x to 4.x, in that case you need backup/restore with --noIndexRestore
  12. # see https://github.com/wekan/wekan/wiki/Backup
  13. # 1) Stop Wekan:
  14. # docker-compose stop
  15. # 2) Remove old Wekan app (wekan-app only, not that wekan-db container that has all your data)
  16. # docker rm wekan-app
  17. # 3) Get newest docker-compose.yml from https://github.com/wekan/wekan to have correct image,
  18. # for example: "image: quay.io/wekan/wekan" or version tag "image: quay.io/wekan/wekan:v4.52"
  19. # 4) Start Wekan:
  20. # docker-compose up -d
  21. #----------------------------------------------------------------------------------
  22. # ==== OPTIONAL: DEDICATED DOCKER USER ====
  23. # 1) Optionally create a dedicated user for Wekan, for example:
  24. # sudo useradd -d /home/wekan -m -s /bin/bash wekan
  25. # 2) Add this user to the docker group, then logout+login or reboot:
  26. # sudo usermod -aG docker wekan
  27. # 3) Then login as user wekan.
  28. # 4) Create this file /home/wekan/docker-compose.yml with your modifications.
  29. #----------------------------------------------------------------------------------
  30. # ==== RUN DOCKER AS SERVICE ====
  31. # 1a) Running Docker as service, on Systemd like Debian 9, Ubuntu 16.04, CentOS 7:
  32. # sudo systemctl enable docker
  33. # sudo systemctl start docker
  34. # 1b) Running Docker as service, on init.d like Debian 8, Ubuntu 14.04, CentOS 6:
  35. # sudo update-rc.d docker defaults
  36. # sudo service docker start
  37. # ----------------------------------------------------------------------------------
  38. # ==== USAGE OF THIS docker-compose.yml ====
  39. # 1) For seeing does Wekan work, try this and check with your webbroser:
  40. # docker-compose up
  41. # 2) Stop Wekan and start Wekan in background:
  42. # docker-compose stop
  43. # docker-compose up -d
  44. # 3) See running Docker containers:
  45. # docker ps
  46. # 4) Stop Docker containers:
  47. # docker-compose stop
  48. # ----------------------------------------------------------------------------------
  49. # ===== INSIDE DOCKER CONTAINERS, AND BACKUP/RESTORE ====
  50. # https://github.com/wekan/wekan/wiki/Backup
  51. # If really necessary, repair MongoDB: https://github.com/wekan/wekan-mongodb/issues/6#issuecomment-424004116
  52. # 1) Going inside containers:
  53. # a) Wekan app, does not contain data
  54. # docker exec -it wekan-app bash
  55. # b) MongoDB, contains all data
  56. # docker exec -it wekan-db bash
  57. # 2) Copying database to outside of container:
  58. # docker exec -it wekan-db bash
  59. # cd /data
  60. # mongodump
  61. # exit
  62. # docker cp wekan-db:/data/dump .
  63. # 3) Restoring database
  64. # # 1) Stop wekan
  65. # docker stop wekan-app
  66. # # 2) Go inside database container
  67. # docker exec -it wekan-db bash
  68. # # 3) and data directory
  69. # cd /data
  70. # # 4) Remove previos dump
  71. # rm -rf dump
  72. # # 5) Exit db container
  73. # exit
  74. # # 6) Copy dump to inside docker container
  75. # docker cp dump wekan-db:/data/
  76. # # 7) Go inside database container
  77. # docker exec -it wekan-db bash
  78. # # 8) and data directory
  79. # cd /data
  80. # # 9) Restore
  81. # mongorestore --drop
  82. # # 10) Exit db container
  83. # exit
  84. # # 11) Start wekan
  85. # docker start wekan-app
  86. #-------------------------------------------------------------------------
  87. # 2020-12-03:
  88. # - base images copied from Docker Hub to Quay to avoid Docker Hub rate limits,
  89. # from: torodb/stampede:1.0.0, postgres:9.6, mongo:3.2
  90. #-------------------------------------------------------------------------
  91. services:
  92. torodb-stampede:
  93. image: quay.io/wekan/torodb-stampede:1.0.0
  94. networks:
  95. - wekan-tier
  96. links:
  97. - postgres
  98. - mongodb
  99. environment:
  100. - POSTGRES_PASSWORD=wekan
  101. - TORODB_SETUP=true
  102. - TORODB_SYNC_SOURCE=mongodb:27017
  103. - TORODB_BACKEND_HOST=postgres
  104. - TORODB_BACKEND_PORT=5432
  105. - TORODB_BACKEND_DATABASE=wekan
  106. - TORODB_BACKEND_USER=wekan
  107. - TORODB_BACKEND_PASSWORD=wekan
  108. - DEBUG
  109. postgres:
  110. image: quay.io/wekan/postgres:9.6
  111. networks:
  112. - wekan-tier
  113. environment:
  114. - POSTGRES_PASSWORD=wekan
  115. ports:
  116. - "5432:5432"
  117. mongodb:
  118. image: mongo:3.2
  119. networks:
  120. - wekan-tier
  121. ports:
  122. - "27017:27017"
  123. entrypoint:
  124. - /bin/bash
  125. - "-c"
  126. - mongo --nodb --eval '
  127. var db;
  128. while (!db) {
  129. try {
  130. db = new Mongo("mongodb:27017").getDB("local");
  131. } catch(ex) {}
  132. sleep(3000);
  133. };
  134. rs.initiate({_id:"rs1",members:[{_id:0,host:"mongodb:27017"}]});
  135. ' 1>/dev/null 2>&1 &
  136. mongod --replSet rs1
  137. wekan:
  138. image: quay.io/wekan/wekan
  139. container_name: wekan-app
  140. restart: always
  141. networks:
  142. - wekan-tier
  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. - 80:8080
  148. environment:
  149. - MONGO_URL=mongodb://mongodb:27017/wekan
  150. #---------------------------------------------------------------
  151. # ==== ROOT_URL SETTING ====
  152. # Change ROOT_URL to your real Wekan URL, for example:
  153. # If you have Caddy/Nginx/Apache providing SSL
  154. # - https://example.com
  155. # - https://boards.example.com
  156. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  157. # - https://example.com/wekan
  158. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  159. # - http://example.com
  160. # - http://boards.example.com
  161. # - http://192.168.1.100 <=== using at local LAN
  162. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  163. # ==== EMAIL SETTINGS ====
  164. # Email settings are required in both MAIL_URL and Admin Panel,
  165. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  166. # For SSL in email, change smtp:// to smtps://
  167. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  168. # You can encode those characters for example at: https://www.urlencoder.org
  169. - MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  170. - MAIL_FROM='Example Wekan Support <support@example.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 poll-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/smeijer/kadira
  192. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  193. # - export KADIRA_OPTIONS_ENDPOINT=http://127.0.0.1:11011
  194. #---------------------------------------------------------------
  195. # ==== OPTIONAL: LOGS AND STATS ====
  196. # https://github.com/wekan/wekan/wiki/Logs
  197. #
  198. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  199. # https://github.com/wekan/wekan-logstash
  200. #
  201. # Statistics Python script for Wekan Dashboard
  202. # https://github.com/wekan/wekan-stats
  203. #
  204. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  205. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  206. # but there could be bug https://github.com/wekan/wekan/issues/1094
  207. #
  208. # There is Feature Request: Logging date and time of all activity with summary reports,
  209. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  210. #---------------------------------------------------------------
  211. # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ====
  212. #- RESULTS_PER_PAGE=20
  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. # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  240. # https://github.com/wekan/wekan/issues/2518
  241. - CARD_OPENED_WEBHOOK_ENABLED=false
  242. #---------------------------------------------------------------
  243. # ==== Allow to shrink attached/pasted image ====
  244. # https://github.com/wekan/wekan/pull/2544
  245. #-MAX_IMAGE_PIXEL=1024
  246. #-IMAGE_COMPRESS_RATIO=80
  247. #---------------------------------------------------------------
  248. # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  249. # Number of days after a notification is read before we remove it.
  250. # Default: 2
  251. #- NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  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 2 days before and after. 0 = due notifications disabled. Default: 2
  276. #- NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2
  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. Example: *
  288. #- CORS=*
  289. #-----------------------------------------------------------------
  290. # ==== MATOMO INTEGRATION ====
  291. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  292. # The address of the server where Matomo is hosted.
  293. # example: - MATOMO_ADDRESS=https://example.com/matomo
  294. #- MATOMO_ADDRESS=
  295. # The value of the site ID given in Matomo server for Wekan
  296. # example: - MATOMO_SITE_ID=12345
  297. #- MATOMO_SITE_ID=
  298. # The option do not track which enables users to not be tracked by matomo
  299. # example: - MATOMO_DO_NOT_TRACK=false
  300. #- MATOMO_DO_NOT_TRACK=
  301. # The option that allows matomo to retrieve the username:
  302. # example: MATOMO_WITH_USERNAME=true
  303. #- MATOMO_WITH_USERNAME=false
  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=
  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. # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  316. #- WEBHOOKS_ATTRIBUTES=
  317. #-----------------------------------------------------------------
  318. # ==== OAUTH2 ORACLE on premise identity manager OIM ====
  319. #- ORACLE_OIM_ENABLED=true
  320. #-----------------------------------------------------------------
  321. # ==== OAUTH2 ONLY WITH OIDC AND DOORKEEPER AS INDENTITY PROVIDER
  322. # https://github.com/wekan/wekan/issues/1874
  323. # https://github.com/wekan/wekan/wiki/OAuth2
  324. # Enable the OAuth2 connection
  325. # example: OAUTH2_ENABLED=true
  326. #- OAUTH2_ENABLED=false
  327. # Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  328. #- OAUTH2_CA_CERT=ABCD1234
  329. # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  330. #- OAUTH2_ADFS_ENABLED=false
  331. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  332. # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  333. # example: OAUTH2_CLIENT_ID=abcde12345
  334. #- OAUTH2_CLIENT_ID=
  335. # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  336. # example: OAUTH2_SECRET=54321abcde
  337. #- OAUTH2_SECRET=
  338. # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  339. # example: OAUTH2_SERVER_URL=https://chat.example.com
  340. #- OAUTH2_SERVER_URL=
  341. # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  342. # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  343. #- OAUTH2_AUTH_ENDPOINT=
  344. # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  345. # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  346. #- OAUTH2_USERINFO_ENDPOINT=
  347. # OAuth2 Token Endpoint. Example: /oauth/token
  348. # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  349. #- OAUTH2_TOKEN_ENDPOINT=
  350. #-----------------------------------------------------------------
  351. # ==== LDAP ====
  352. # https://github.com/wekan/wekan/wiki/LDAP
  353. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  354. # Most settings work both on Snap and Docker below.
  355. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  356. #
  357. # DEFAULT_AUTHENTICATION_METHOD : The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  358. # example : DEFAULT_AUTHENTICATION_METHOD=ldap
  359. #- DEFAULT_AUTHENTICATION_METHOD=
  360. #
  361. # LDAP_ENABLE : Enable or not the connection by the LDAP
  362. # example : LDAP_ENABLE=true
  363. #- LDAP_ENABLE=false
  364. #
  365. # LDAP_PORT : The port of the LDAP server
  366. # example : LDAP_PORT=389
  367. #- LDAP_PORT=389
  368. #
  369. # LDAP_HOST : The host server for the LDAP server
  370. # example : LDAP_HOST=localhost
  371. #- LDAP_HOST=
  372. #
  373. # LDAP_BASEDN : The base DN for the LDAP Tree
  374. # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  375. #- LDAP_BASEDN=
  376. #
  377. # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  378. # example : LDAP_LOGIN_FALLBACK=true
  379. #- LDAP_LOGIN_FALLBACK=false
  380. #
  381. # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  382. # example : LDAP_RECONNECT=false
  383. #- LDAP_RECONNECT=true
  384. #
  385. # LDAP_TIMEOUT : Overall timeout, in milliseconds
  386. # example : LDAP_TIMEOUT=12345
  387. #- LDAP_TIMEOUT=10000
  388. #
  389. # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  390. # example : LDAP_IDLE_TIMEOUT=12345
  391. #- LDAP_IDLE_TIMEOUT=10000
  392. #
  393. # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  394. # example : LDAP_CONNECT_TIMEOUT=12345
  395. #- LDAP_CONNECT_TIMEOUT=10000
  396. #
  397. # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  398. # example : LDAP_AUTHENTIFICATION=true
  399. #- LDAP_AUTHENTIFICATION=false
  400. #
  401. # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  402. # example : LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  403. #- LDAP_AUTHENTIFICATION_USERDN=
  404. #
  405. # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  406. # example : AUTHENTIFICATION_PASSWORD=admin
  407. #- LDAP_AUTHENTIFICATION_PASSWORD=
  408. #
  409. # LDAP_LOG_ENABLED : Enable logs for the module
  410. # example : LDAP_LOG_ENABLED=true
  411. #- LDAP_LOG_ENABLED=false
  412. #
  413. # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  414. # example : LDAP_BACKGROUND_SYNC=true
  415. #- LDAP_BACKGROUND_SYNC=false
  416. #
  417. # At which interval does the background task sync.
  418. # The format must be as specified in:
  419. # https://bunkat.github.io/later/parsers.html#text
  420. #- LDAP_BACKGROUND_SYNC_INTERVAL='every 1 hour'
  421. #
  422. # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  423. # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  424. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  425. #
  426. # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  427. # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  428. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  429. #
  430. # LDAP_ENCRYPTION : If using LDAPS
  431. # example : LDAP_ENCRYPTION=ssl
  432. #- LDAP_ENCRYPTION=false
  433. #
  434. # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  435. # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  436. #- LDAP_CA_CERT=
  437. #
  438. # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  439. # example : LDAP_REJECT_UNAUTHORIZED=true
  440. #- LDAP_REJECT_UNAUTHORIZED=false
  441. #
  442. # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  443. # example : LDAP_USER_SEARCH_FILTER=
  444. #- LDAP_USER_SEARCH_FILTER=
  445. #
  446. # 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)
  447. # example : LDAP_USER_SEARCH_SCOPE=one
  448. #- LDAP_USER_SEARCH_SCOPE=
  449. #
  450. # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  451. # example : LDAP_USER_SEARCH_FIELD=uid
  452. #- LDAP_USER_SEARCH_FIELD=
  453. #
  454. # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  455. # example : LDAP_SEARCH_PAGE_SIZE=12345
  456. #- LDAP_SEARCH_PAGE_SIZE=0
  457. #
  458. # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  459. # example : LDAP_SEARCH_SIZE_LIMIT=12345
  460. #- LDAP_SEARCH_SIZE_LIMIT=0
  461. #
  462. # 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
  463. # example : LDAP_GROUP_FILTER_ENABLE=true
  464. #- LDAP_GROUP_FILTER_ENABLE=false
  465. #
  466. # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  467. # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  468. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  469. #
  470. # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE : The attribute of a group identifying it
  471. # example : LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=cn
  472. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  473. #
  474. # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE : The attribute inside a group object listing its members
  475. # example : member
  476. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  477. #
  478. # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT : The format of the value of LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE
  479. # example : dn
  480. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  481. #
  482. # LDAP_GROUP_FILTER_GROUP_NAME : The group name (id) that matches all users
  483. # example : wekan_users
  484. #- LDAP_GROUP_FILTER_GROUP_NAME=
  485. #
  486. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  487. # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  488. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  489. #
  490. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  491. # example : LDAP_UTF8_NAMES_SLUGIFY=false
  492. #- LDAP_UTF8_NAMES_SLUGIFY=true
  493. #
  494. # LDAP_USERNAME_FIELD : Which field contains the ldap username
  495. # example : LDAP_USERNAME_FIELD=username
  496. #- LDAP_USERNAME_FIELD=
  497. #
  498. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname
  499. # example : LDAP_FULLNAME_FIELD=fullname
  500. #- LDAP_FULLNAME_FIELD=
  501. #
  502. # LDAP_MERGE_EXISTING_USERS :
  503. # example : LDAP_MERGE_EXISTING_USERS=true
  504. #- LDAP_MERGE_EXISTING_USERS=false
  505. #-----------------------------------------------------------------
  506. # LDAP_SYNC_USER_DATA :
  507. # example : LDAP_SYNC_USER_DATA=true
  508. #- LDAP_SYNC_USER_DATA=false
  509. #
  510. # LDAP_SYNC_USER_DATA_FIELDMAP :
  511. # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  512. #- LDAP_SYNC_USER_DATA_FIELDMAP=
  513. #
  514. # LDAP_SYNC_GROUP_ROLES :
  515. # example :
  516. #- LDAP_SYNC_GROUP_ROLES=
  517. #
  518. # 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
  519. # example :
  520. #- LDAP_DEFAULT_DOMAIN=
  521. #---------------------------------------------------------------------
  522. # ==== LOGOUT TIMER, probably does not work yet ====
  523. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  524. # example : LOGOUT_WITH_TIMER=true
  525. #- LOGOUT_WITH_TIMER=
  526. #
  527. # LOGOUT_IN : The number of days
  528. # example : LOGOUT_IN=1
  529. #- LOGOUT_IN=
  530. #
  531. # LOGOUT_ON_HOURS : The number of hours
  532. # example : LOGOUT_ON_HOURS=9
  533. #- LOGOUT_ON_HOURS=
  534. #
  535. # LOGOUT_ON_MINUTES : The number of minutes
  536. # example : LOGOUT_ON_MINUTES=55
  537. #- LOGOUT_ON_MINUTES=
  538. #---------------------------------------------------------------------
  539. # PASSWORD_LOGIN_ENABLED : Enable or not the password login form.
  540. # example: PASSWORD_LOGIN_ENABLED=false
  541. # - PASSWORD_LOGIN_ENABLED
  542. #-------------------------------------------------------------------
  543. #- CAS_ENABLED=true
  544. #- CAS_BASE_URL=https://cas.example.com/cas
  545. #- CAS_LOGIN_URL=https://cas.example.com/login
  546. #- CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  547. #---------------------------------------------------------------------
  548. #- SAML_ENABLED=true
  549. #- SAML_PROVIDER=
  550. #- SAML_ENTRYPOINT=
  551. #- SAML_ISSUER=
  552. #- SAML_CERT=
  553. #- SAML_IDPSLO_REDIRECTURL=
  554. #- SAML_PRIVATE_KEYFILE=
  555. #- SAML_PUBLIC_CERTFILE=
  556. #- SAML_IDENTIFIER_FORMAT=
  557. #- SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  558. #- SAML_ATTRIBUTES=
  559. #---------------------------------------------------------------------
  560. # Wait spinner to use
  561. #- WAIT_SPINNER=Bounce
  562. #---------------------------------------------------------------------
  563. depends_on:
  564. - mongodb
  565. #---------------------------------------------------------------------------------
  566. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  567. # When using Wekan both at office LAN and remote VPN:
  568. # 1) Have above Wekan docker container config with LAN IP address
  569. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  570. # before above depends_on: part:
  571. #
  572. # wekan:
  573. # #-------------------------------------------------------------------------------------
  574. # # ==== MONGODB AND METEOR VERSION ====
  575. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  576. #
  577. #
  578. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  579. # address.
  580. # 3) This way both Wekan containers can use same MongoDB database
  581. # and see the same Wekan boards.
  582. # 4) You could also add 3rd Wekan container for 3rd network etc.
  583. # EXAMPLE:
  584. # wekan2:
  585. # ....COPY CONFIG FROM ABOVE TO HERE...
  586. # environment:
  587. # - ROOT_URL='http://10.10.10.10'
  588. # ...COPY CONFIG FROM ABOVE TO HERE...
  589. #---------------------------------------------------------------------------------
  590. volumes:
  591. mongodb:
  592. driver: local
  593. mongodb-dump:
  594. driver: local
  595. networks:
  596. wekan-tier:
  597. driver: bridge