docker-compose.yml 25 KB

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