docker-compose.yml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559
  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. #-----------------------------------------------------------------------------------
  88. # ==== OPTIONAL Wekan <=> MongoDB <=> ToroDB => PostgreSQL read-only mirroring ====
  89. # For reporting with SQL, and accessing with any programming language,
  90. # reporting package and Office suite that can connect to PostgreSQL.
  91. # https://github.com/wekan/wekan-postgresql
  92. #
  93. #torodb-stampede:
  94. # image: torodb/stampede:1.0.0-SNAPSHOT
  95. # networks:
  96. # - wekan-tier
  97. # links:
  98. # - postgres
  99. # - wekandb
  100. # environment:
  101. # - POSTGRES_PASSWORD
  102. # - TORODB_SETUP=true
  103. # - TORODB_SYNC_SOURCE=mongodb:27017
  104. # - TORODB_BACKEND_HOST=postgres
  105. # - TORODB_BACKEND_PORT=5432
  106. # - TORODB_BACKEND_DATABASE=wekan
  107. # - TORODB_BACKEND_USER=wekan
  108. # - TORODB_BACKEND_PASSWORD=wekan
  109. # - DEBUG
  110. #postgres:
  111. # image: postgres:9.6
  112. # networks:
  113. # - wekan-tier
  114. # environment:
  115. # - POSTGRES_PASSWORD
  116. # ports:
  117. # - "15432:5432"
  118. #wekandb:
  119. # image: mongo:3.2
  120. # networks:
  121. # - wekan-tier
  122. # ports:
  123. # - "28017:27017"
  124. # entrypoint:
  125. # - /bin/bash
  126. # - "-c"
  127. # - mongo --nodb --eval '
  128. # var db;
  129. # while (!db) {
  130. # try {
  131. # db = new Mongo("mongodb:27017").getDB("local");
  132. # } catch(ex) {}
  133. # sleep(3000);
  134. # };
  135. # rs.initiate({_id:"rs1",members:[{_id:0,host:"mongodb:27017"}]});
  136. # ' 1>/dev/null 2>&1 &
  137. # mongod --replSet rs1
  138. #---------------------------------------------------------------------------------------
  139. # === FOR ABOVE ToroDB, UNCOMMENT all of above with wekandb: mongo:3.2 that is only ===
  140. # === compatible with ToroDB, and COMMENT OUF all of below wekandb: with mongo:4.0.4 ===
  141. # === and mongo:3.2.21 ===
  142. #-----------------------:::--------------------------------------------------------------
  143. wekandb:
  144. #-------------------------------------------------------------------------------------
  145. # ==== MONGODB AND METEOR VERSION ====
  146. # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, use mongo 4.x
  147. image: mongo:4.0.4
  148. # b) For Wekan Meteor 1.6.x version at master/devel/edge branches.
  149. # Only for Snap and Sandstorm while they are not upgraded yet to Meteor 1.8.x
  150. # image: mongo:3.2.21
  151. #-------------------------------------------------------------------------------------
  152. container_name: wekan-db
  153. restart: always
  154. command: mongod --smallfiles --oplogSize 128
  155. networks:
  156. - wekan-tier
  157. expose:
  158. - 27017
  159. volumes:
  160. - wekan-db:/data/db
  161. - wekan-db-dump:/dump
  162. wekan:
  163. #-------------------------------------------------------------------------------------
  164. # ==== MONGODB AND METEOR VERSION ====
  165. # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch,
  166. # using https://quay.io/wekan/wekan automatic builds
  167. image: quay.io/wekan/wekan:meteor-1.8
  168. # b) For Wekan Meteor 1.6.x version at master/devel/edge branches.
  169. # Only for Snap and Sandstorm while they are not upgraded yet to Meteor 1.8.x
  170. # image: quay.io/wekan/wekan
  171. # c) Using specific Meteor 1.6.x version tag:
  172. # image: quay.io/wekan/wekan:v1.95
  173. # c) Using Docker Hub automatic builds https://hub.docker.com/r/wekanteam/wekan
  174. # image: wekanteam/wekan:meteor-1.8
  175. # image: wekanteam/wekan:v1.95
  176. #-------------------------------------------------------------------------------------
  177. container_name: wekan-app
  178. restart: always
  179. networks:
  180. - wekan-tier
  181. #-------------------------------------------------------------------------------------
  182. # ==== BUILD wekan-app DOCKER CONTAINER FROM SOURCE, if you uncomment these ====
  183. #build:
  184. # context: .
  185. # dockerfile: Dockerfile
  186. # args:
  187. # - NODE_VERSION=${NODE_VERSION}
  188. # - METEOR_RELEASE=${METEOR_RELEASE}
  189. # - NPM_VERSION=${NPM_VERSION}
  190. # - ARCHITECTURE=${ARCHITECTURE}
  191. # - SRC_PATH=${SRC_PATH}
  192. # - METEOR_EDGE=${METEOR_EDGE}
  193. # - USE_EDGE=${USE_EDGE}
  194. #-------------------------------------------------------------------------------------
  195. ports:
  196. # Docker outsideport:insideport. Do not add anything extra here.
  197. # For example, if you want to have wekan on port 3001,
  198. # use 3001:8080 . Do not add any extra address etc here, that way it does not work.
  199. - 80:8080
  200. environment:
  201. - MONGO_URL=mongodb://wekandb:27017/wekan
  202. #---------------------------------------------------------------
  203. # ==== ROOT_URL SETTING ====
  204. # Change ROOT_URL to your real Wekan URL, for example:
  205. # If you have Caddy/Nginx/Apache providing SSL
  206. # - https://example.com
  207. # - https://boards.example.com
  208. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  209. # - https://example.com/wekan
  210. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  211. # - http://example.com
  212. # - http://boards.example.com
  213. # - http://192.168.1.100 <=== using at local LAN
  214. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  215. #---------------------------------------------------------------
  216. # ==== EMAIL SETTINGS ====
  217. # Email settings are required in both MAIL_URL and Admin Panel,
  218. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  219. # For SSL in email, change smtp:// to smtps://
  220. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  221. # You can encode those characters for example at: https://www.urlencoder.org
  222. - MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  223. - MAIL_FROM='Example Wekan Support <support@example.com>'
  224. #---------------------------------------------------------------
  225. # ==== OPTIONAL: MONGO OPLOG SETTINGS =====
  226. # https://github.com/wekan/wekan-mongodb/issues/2#issuecomment-378343587
  227. # We've fixed our CPU usage problem today with an environment
  228. # change around Wekan. I wasn't aware during implementation
  229. # that if you're using more than 1 instance of Wekan
  230. # (or any MeteorJS based tool) you're supposed to set
  231. # MONGO_OPLOG_URL as an environment variable.
  232. # Without setting it, Meteor will perform a pull-and-diff
  233. # update of it's dataset. With it, Meteor will update from
  234. # the OPLOG. See here
  235. # https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908
  236. # After setting
  237. # MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  238. # the CPU usage for all Wekan instances dropped to an average
  239. # of less than 10% with only occasional spikes to high usage
  240. # (I guess when someone is doing a lot of work)
  241. # - MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  242. #---------------------------------------------------------------
  243. # ==== OPTIONAL: KADIRA PERFORMANCE MONITORING FOR METEOR ====
  244. # https://github.com/smeijer/kadira
  245. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  246. # - export KADIRA_OPTIONS_ENDPOINT=http://127.0.0.1:11011
  247. #---------------------------------------------------------------
  248. # ==== OPTIONAL: LOGS AND STATS ====
  249. # https://github.com/wekan/wekan/wiki/Logs
  250. #
  251. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  252. # https://github.com/wekan/wekan-logstash
  253. #
  254. # Statistics Python script for Wekan Dashboard
  255. # https://github.com/wekan/wekan-stats
  256. #
  257. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  258. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  259. # but there could be bug https://github.com/wekan/wekan/issues/1094
  260. #
  261. # There is Feature Request: Logging date and time of all activity with summary reports,
  262. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  263. #---------------------------------------------------------------
  264. # ==== WEKAN API AND EXPORT BOARD ====
  265. # Wekan Export Board works when WITH_API=true.
  266. # https://github.com/wekan/wekan/wiki/REST-API
  267. # https://github.com/wekan/wekan-gogs
  268. # If you disable Wekan API with false, Export Board does not work.
  269. - WITH_API=true
  270. #-----------------------------------------------------------------
  271. # ==== CORS =====
  272. # CORS: Set Access-Control-Allow-Origin header. Example: *
  273. #- CORS=*
  274. #-----------------------------------------------------------------
  275. # ==== MATOMO INTEGRATION ====
  276. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  277. # The address of the server where Matomo is hosted.
  278. # example: - MATOMO_ADDRESS=https://example.com/matomo
  279. #- MATOMO_ADDRESS=
  280. # The value of the site ID given in Matomo server for Wekan
  281. # example: - MATOMO_SITE_ID=12345
  282. #- MATOMO_SITE_ID=
  283. # The option do not track which enables users to not be tracked by matomo
  284. # example: - MATOMO_DO_NOT_TRACK=false
  285. #- MATOMO_DO_NOT_TRACK=
  286. # The option that allows matomo to retrieve the username:
  287. # example: MATOMO_WITH_USERNAME=true
  288. #- MATOMO_WITH_USERNAME=false
  289. #-----------------------------------------------------------------
  290. # ==== BROWSER POLICY AND TRUSTED IFRAME URL ====
  291. # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  292. # Setting this to false is not recommended, it also disables all other browser policy protections
  293. # and allows all iframing etc. See wekan/server/policy.js
  294. - BROWSER_POLICY_ENABLED=true
  295. # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  296. #- TRUSTED_URL=
  297. #-----------------------------------------------------------------
  298. # ==== OUTGOING WEBHOOKS ====
  299. # What to send to Outgoing Webhook, or leave out. Example, that includes all that are default: cardId,listId,oldListId,boardId,comment,user,card,commentId .
  300. # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  301. #- WEBHOOKS_ATTRIBUTES=
  302. #-----------------------------------------------------------------
  303. # ==== OAUTH2 ONLY WITH OIDC AND DOORKEEPER AS INDENTITY PROVIDER
  304. # https://github.com/wekan/wekan/issues/1874
  305. # https://github.com/wekan/wekan/wiki/OAuth2
  306. # Enable the OAuth2 connection
  307. # example: OAUTH2_ENABLED=true
  308. #- OAUTH2_ENABLED=false
  309. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  310. # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  311. # example: OAUTH2_CLIENT_ID=abcde12345
  312. #- OAUTH2_CLIENT_ID=
  313. # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  314. # example: OAUTH2_SECRET=54321abcde
  315. #- OAUTH2_SECRET=
  316. # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  317. # example: OAUTH2_SERVER_URL=https://chat.example.com
  318. #- OAUTH2_SERVER_URL=
  319. # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  320. # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  321. #- OAUTH2_AUTH_ENDPOINT=
  322. # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  323. # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  324. #- OAUTH2_USERINFO_ENDPOINT=
  325. # OAuth2 Token Endpoint. Example: /oauth/token
  326. # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  327. #- OAUTH2_TOKEN_ENDPOINT=
  328. #-----------------------------------------------------------------
  329. # ==== LDAP ====
  330. # https://github.com/wekan/wekan/wiki/LDAP
  331. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  332. # Most settings work both on Snap and Docker below.
  333. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  334. #
  335. # DEFAULT_AUTHENTICATION_METHOD : The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  336. # example : DEFAULT_AUTHENTICATION_METHOD=ldap
  337. #- DEFAULT_AUTHENTICATION_METHOD=
  338. #
  339. # LDAP_ENABLE : Enable or not the connection by the LDAP
  340. # example : LDAP_ENABLE=true
  341. #- LDAP_ENABLE=false
  342. #
  343. # LDAP_PORT : The port of the LDAP server
  344. # example : LDAP_PORT=389
  345. #- LDAP_PORT=389
  346. #
  347. # LDAP_HOST : The host server for the LDAP server
  348. # example : LDAP_HOST=localhost
  349. #- LDAP_HOST=
  350. #
  351. # LDAP_BASEDN : The base DN for the LDAP Tree
  352. # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  353. #- LDAP_BASEDN=
  354. #
  355. # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  356. # example : LDAP_LOGIN_FALLBACK=true
  357. #- LDAP_LOGIN_FALLBACK=false
  358. #
  359. # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  360. # example : LDAP_RECONNECT=false
  361. #- LDAP_RECONNECT=true
  362. #
  363. # LDAP_TIMEOUT : Overall timeout, in milliseconds
  364. # example : LDAP_TIMEOUT=12345
  365. #- LDAP_TIMEOUT=10000
  366. #
  367. # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  368. # example : LDAP_IDLE_TIMEOUT=12345
  369. #- LDAP_IDLE_TIMEOUT=10000
  370. #
  371. # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  372. # example : LDAP_CONNECT_TIMEOUT=12345
  373. #- LDAP_CONNECT_TIMEOUT=10000
  374. #
  375. # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  376. # example : LDAP_AUTHENTIFICATION=true
  377. #- LDAP_AUTHENTIFICATION=false
  378. #
  379. # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  380. # example : LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  381. #- LDAP_AUTHENTIFICATION_USERDN=
  382. #
  383. # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  384. # example : AUTHENTIFICATION_PASSWORD=admin
  385. #- LDAP_AUTHENTIFICATION_PASSWORD=
  386. #
  387. # LDAP_LOG_ENABLED : Enable logs for the module
  388. # example : LDAP_LOG_ENABLED=true
  389. #- LDAP_LOG_ENABLED=false
  390. #
  391. # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  392. # example : LDAP_BACKGROUND_SYNC=true
  393. #- LDAP_BACKGROUND_SYNC=false
  394. #
  395. # LDAP_BACKGROUND_SYNC_INTERVAL : At which interval does the background task sync in milliseconds
  396. # example : LDAP_BACKGROUND_SYNC_INTERVAL=12345
  397. #- LDAP_BACKGROUND_SYNC_INTERVAL=100
  398. #
  399. # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  400. # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  401. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  402. #
  403. # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  404. # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  405. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  406. #
  407. # LDAP_ENCRYPTION : If using LDAPS
  408. # example : LDAP_ENCRYPTION=ssl
  409. #- LDAP_ENCRYPTION=false
  410. #
  411. # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  412. # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  413. #- LDAP_CA_CERT=
  414. #
  415. # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  416. # example : LDAP_REJECT_UNAUTHORIZED=true
  417. #- LDAP_REJECT_UNAUTHORIZED=false
  418. #
  419. # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  420. # example : LDAP_USER_SEARCH_FILTER=
  421. #- LDAP_USER_SEARCH_FILTER=
  422. #
  423. # 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)
  424. # example : LDAP_USER_SEARCH_SCOPE=one
  425. #- LDAP_USER_SEARCH_SCOPE=
  426. #
  427. # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  428. # example : LDAP_USER_SEARCH_FIELD=uid
  429. #- LDAP_USER_SEARCH_FIELD=
  430. #
  431. # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  432. # example : LDAP_SEARCH_PAGE_SIZE=12345
  433. #- LDAP_SEARCH_PAGE_SIZE=0
  434. #
  435. # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  436. # example : LDAP_SEARCH_SIZE_LIMIT=12345
  437. #- LDAP_SEARCH_SIZE_LIMIT=0
  438. #
  439. # LDAP_GROUP_FILTER_ENABLE : Enable group filtering
  440. # example : LDAP_GROUP_FILTER_ENABLE=true
  441. #- LDAP_GROUP_FILTER_ENABLE=false
  442. #
  443. # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  444. # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  445. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  446. #
  447. # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE :
  448. # example :
  449. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  450. #
  451. # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE :
  452. # example :
  453. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  454. #
  455. # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT :
  456. # example :
  457. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  458. #
  459. # LDAP_GROUP_FILTER_GROUP_NAME :
  460. # example :
  461. #- LDAP_GROUP_FILTER_GROUP_NAME=
  462. #
  463. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  464. # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  465. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  466. #
  467. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  468. # example : LDAP_UTF8_NAMES_SLUGIFY=false
  469. #- LDAP_UTF8_NAMES_SLUGIFY=true
  470. #
  471. # LDAP_USERNAME_FIELD : Which field contains the ldap username
  472. # example : LDAP_USERNAME_FIELD=username
  473. #- LDAP_USERNAME_FIELD=
  474. #
  475. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname
  476. # example : LDAP_FULLNAME_FIELD=fullname
  477. #- LDAP_FULLNAME_FIELD=
  478. #
  479. # LDAP_MERGE_EXISTING_USERS :
  480. # example : LDAP_MERGE_EXISTING_USERS=true
  481. #- LDAP_MERGE_EXISTING_USERS=false
  482. #-----------------------------------------------------------------
  483. # LDAP_SYNC_USER_DATA :
  484. # example : LDAP_SYNC_USER_DATA=true
  485. #- LDAP_SYNC_USER_DATA=false
  486. #
  487. # LDAP_SYNC_USER_DATA_FIELDMAP :
  488. # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  489. #- LDAP_SYNC_USER_DATA_FIELDMAP=
  490. #
  491. # LDAP_SYNC_GROUP_ROLES :
  492. # example :
  493. #- LDAP_SYNC_GROUP_ROLES=
  494. #
  495. # 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
  496. # example :
  497. #- LDAP_DEFAULT_DOMAIN=
  498. #---------------------------------------------------------------------
  499. # ==== LOGOUT TIMER, probably does not work yet ====
  500. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  501. # example : LOGOUT_WITH_TIMER=true
  502. #- LOGOUT_WITH_TIMER=
  503. #
  504. # LOGOUT_IN : The number of days
  505. # example : LOGOUT_IN=1
  506. #- LOGOUT_IN=
  507. #
  508. # LOGOUT_ON_HOURS : The number of hours
  509. # example : LOGOUT_ON_HOURS=9
  510. #- LOGOUT_ON_HOURS=
  511. #
  512. # LOGOUT_ON_MINUTES : The number of minutes
  513. # example : LOGOUT_ON_MINUTES=55
  514. #- LOGOUT_ON_MINUTES=
  515. #-------------------------------------------------------------------
  516. depends_on:
  517. - wekandb
  518. #---------------------------------------------------------------------------------
  519. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  520. # When using Wekan both at office LAN and remote VPN:
  521. # 1) Have above Wekan docker container config with LAN IP address
  522. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  523. # before above depends_on: part:
  524. #
  525. # wekan:
  526. # #-------------------------------------------------------------------------------------
  527. # # ==== MONGODB AND METEOR VERSION ====
  528. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  529. #
  530. #
  531. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  532. # address.
  533. # 3) This way both Wekan containers can use same MongoDB database
  534. # and see the same Wekan boards.
  535. # 4) You could also add 3rd Wekan container for 3rd network etc.
  536. # EXAMPLE:
  537. # wekan2:
  538. # ....COPY CONFIG FROM ABOVE TO HERE...
  539. # environment:
  540. # - ROOT_URL='http://10.10.10.10'
  541. # ...COPY CONFIG FROM ABOVE TO HERE...
  542. #---------------------------------------------------------------------------------
  543. volumes:
  544. wekan-db:
  545. driver: local
  546. wekan-db-dump:
  547. driver: local
  548. networks:
  549. wekan-tier:
  550. driver: bridge