docker-compose.yml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  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. volumes:
  110. - /etc/localtime:/etc/localtime:ro
  111. postgres:
  112. image: quay.io/wekan/postgres:9.6
  113. networks:
  114. - wekan-tier
  115. environment:
  116. - POSTGRES_PASSWORD=wekan
  117. ports:
  118. - "5432:5432"
  119. volumes:
  120. - /etc/localtime:/etc/localtime:ro
  121. mongodb:
  122. image: mongo:3.2
  123. networks:
  124. - wekan-tier
  125. ports:
  126. - "27017:27017"
  127. entrypoint:
  128. - /bin/bash
  129. - "-c"
  130. - mongo --nodb --eval '
  131. var db;
  132. while (!db) {
  133. try {
  134. db = new Mongo("mongodb:27017").getDB("local");
  135. } catch(ex) {}
  136. sleep(3000);
  137. };
  138. rs.initiate({_id:"rs1",members:[{_id:0,host:"mongodb:27017"}]});
  139. ' 1>/dev/null 2>&1 &
  140. mongod --replSet rs1
  141. volumes:
  142. - /etc/localtime:/etc/localtime:ro
  143. - /etc/timezone:/etc/timezone:ro
  144. - mongodb:/data/db
  145. - mongodb-dump:/dump
  146. wekan:
  147. image: quay.io/wekan/wekan
  148. container_name: wekan-app
  149. restart: always
  150. networks:
  151. - wekan-tier
  152. ports:
  153. # Docker outsideport:insideport. Do not add anything extra here.
  154. # For example, if you want to have wekan on port 3001,
  155. # use 3001:8080 . Do not add any extra address etc here, that way it does not work.
  156. - 80:8080
  157. environment:
  158. - MONGO_URL=mongodb://mongodb:27017/wekan
  159. #---------------------------------------------------------------
  160. # ==== ROOT_URL SETTING ====
  161. # Change ROOT_URL to your real Wekan URL, for example:
  162. # If you have Caddy/Nginx/Apache providing SSL
  163. # - https://example.com
  164. # - https://boards.example.com
  165. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  166. # - https://example.com/wekan
  167. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  168. # - http://example.com
  169. # - http://boards.example.com
  170. # - http://192.168.1.100 <=== using at local LAN
  171. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  172. # ==== EMAIL SETTINGS ====
  173. # Email settings are only at MAIL_URL and MAIL_FROM.
  174. # Admin Panel has test button, but it's not used for settings.
  175. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  176. # For SSL in email, change smtp:// to smtps://
  177. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  178. # You can encode those characters for example at: https://www.urlencoder.org
  179. - MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  180. - MAIL_FROM='Example Wekan Support <support@example.com>'
  181. # Currently MAIL_SERVICE is not in use.
  182. #- MAIL_SERVICE=Outlook365
  183. #- MAIL_SERVICE_USER=firstname.lastname@hotmail.com
  184. #- MAIL_SERVICE_PASSWORD=SecretPassword
  185. #---------------------------------------------------------------
  186. # https://github.com/wekan/wekan/issues/3585#issuecomment-1021522132
  187. # Add more Node heap, this is done by default at Dockerfile:
  188. # - NODE_OPTIONS="--max_old_space_size=4096"
  189. # Add more stack, this is done at Dockerfile:
  190. # bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js"
  191. #---------------------------------------------------------------
  192. # ==== OPTIONAL: MONGO OPLOG SETTINGS =====
  193. # https://github.com/wekan/wekan-mongodb/issues/2#issuecomment-378343587
  194. # We've fixed our CPU usage problem today with an environment
  195. # change around Wekan. I wasn't aware during implementation
  196. # that if you're using more than 1 instance of Wekan
  197. # (or any MeteorJS based tool) you're supposed to set
  198. # MONGO_OPLOG_URL as an environment variable.
  199. # Without setting it, Meteor will perform a poll-and-diff
  200. # update of it's dataset. With it, Meteor will update from
  201. # the OPLOG. See here
  202. # https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908
  203. # After setting
  204. # MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  205. # the CPU usage for all Wekan instances dropped to an average
  206. # of less than 10% with only occasional spikes to high usage
  207. # (I guess when someone is doing a lot of work)
  208. # - MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  209. #---------------------------------------------------------------
  210. # ==== OPTIONAL: KADIRA PERFORMANCE MONITORING FOR METEOR ====
  211. # https://github.com/smeijer/kadira
  212. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  213. # - export KADIRA_OPTIONS_ENDPOINT=http://127.0.0.1:11011
  214. #---------------------------------------------------------------
  215. # ==== OPTIONAL: LOGS AND STATS ====
  216. # https://github.com/wekan/wekan/wiki/Logs
  217. #
  218. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  219. # https://github.com/wekan/wekan-logstash
  220. #
  221. # Statistics Python script for Wekan Dashboard
  222. # https://github.com/wekan/wekan-stats
  223. #
  224. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  225. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  226. # but there could be bug https://github.com/wekan/wekan/issues/1094
  227. #
  228. # There is Feature Request: Logging date and time of all activity with summary reports,
  229. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  230. #---------------------------------------------------------------
  231. # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ====
  232. #- RESULTS_PER_PAGE=20
  233. #---------------------------------------------------------------
  234. # ==== WEKAN API AND EXPORT BOARD ====
  235. # Wekan Export Board works when WITH_API=true.
  236. # https://github.com/wekan/wekan/wiki/REST-API
  237. # https://github.com/wekan/wekan-gogs
  238. # If you disable Wekan API with false, Export Board does not work.
  239. - WITH_API=true
  240. #---------------------------------------------------------------
  241. # ==== PASSWORD BRUTE FORCE PROTECTION ====
  242. #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  243. #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  244. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  245. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  246. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  247. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  248. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  249. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  250. #---------------------------------------------------------------
  251. # ==== ACCOUNT OPTIONS ====
  252. # https://docs.meteor.com/api/accounts-multi.html#AccountsCommon-config
  253. # Defaults below. Uncomment to change. wekan/server/accounts-common.js
  254. # - ACCOUNTS_COMMON_LOGIN_EXPIRATION_IN_DAYS=90
  255. #---------------------------------------------------------------
  256. # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  257. # https://github.com/wekan/wekan/pull/2560
  258. - RICHER_CARD_COMMENT_EDITOR=false
  259. #---------------------------------------------------------------
  260. # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  261. # https://github.com/wekan/wekan/issues/2518
  262. - CARD_OPENED_WEBHOOK_ENABLED=false
  263. #---------------------------------------------------------------
  264. # ==== Allow to shrink attached/pasted image ====
  265. # https://github.com/wekan/wekan/pull/2544
  266. #-MAX_IMAGE_PIXEL=1024
  267. #-IMAGE_COMPRESS_RATIO=80
  268. #---------------------------------------------------------------
  269. # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  270. # Number of days after a notification is read before we remove it.
  271. # Default: 2
  272. #- NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  273. #---------------------------------------------------------------
  274. # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  275. # https://github.com/wekan/wekan/pull/2541
  276. # Introduced a system env var BIGEVENTS_PATTERN default as "NONE",
  277. # so any activityType matches the pattern, system will send out
  278. # notifications to all board members no matter they are watching
  279. # or tracking the board or not. Owner of the wekan server can
  280. # disable the feature by setting this variable to "NONE" or
  281. # change the pattern to any valid regex. i.e. '|' delimited
  282. # activityType names.
  283. # a) Example
  284. #- BIGEVENTS_PATTERN=due
  285. # b) All
  286. #- BIGEVENTS_PATTERN=received|start|due|end
  287. # c) Disabled
  288. - BIGEVENTS_PATTERN=NONE
  289. #---------------------------------------------------------------
  290. # ==== EMAIL DUE DATE NOTIFICATION =====
  291. # https://github.com/wekan/wekan/pull/2536
  292. # System timelines will be showing any user modification for
  293. # dueat startat endat receivedat, also notification to
  294. # the watchers and if any card is due, about due or past due.
  295. #
  296. # Notify due days, default 2 days before and after. 0 = due notifications disabled. Default: 2
  297. #- NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2
  298. #
  299. # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  300. # If env variable has parsing error, use default. Notification sent to watchers.
  301. #- NOTIFY_DUE_AT_HOUR_OF_DAY=8
  302. #-----------------------------------------------------------------
  303. # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  304. # Defaut: 30000 ms = 30s
  305. #- EMAIL_NOTIFICATION_TIMEOUT=30000
  306. #-----------------------------------------------------------------
  307. # ==== CORS =====
  308. # CORS: Set Access-Control-Allow-Origin header. Example: *
  309. #- CORS=*
  310. #-----------------------------------------------------------------
  311. # ==== MATOMO INTEGRATION ====
  312. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  313. # The address of the server where Matomo is hosted.
  314. # example: - MATOMO_ADDRESS=https://example.com/matomo
  315. #- MATOMO_ADDRESS=
  316. # The value of the site ID given in Matomo server for Wekan
  317. # example: - MATOMO_SITE_ID=12345
  318. #- MATOMO_SITE_ID=
  319. # The option do not track which enables users to not be tracked by matomo
  320. # example: - MATOMO_DO_NOT_TRACK=false
  321. #- MATOMO_DO_NOT_TRACK=
  322. # The option that allows matomo to retrieve the username:
  323. # example: MATOMO_WITH_USERNAME=true
  324. #- MATOMO_WITH_USERNAME=false
  325. #-----------------------------------------------------------------
  326. # ==== BROWSER POLICY AND TRUSTED IFRAME URL ====
  327. # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  328. # Setting this to false is not recommended, it also disables all other browser policy protections
  329. # and allows all iframing etc. See wekan/server/policy.js
  330. - BROWSER_POLICY_ENABLED=true
  331. # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  332. #- TRUSTED_URL=
  333. #-----------------------------------------------------------------
  334. # ==== WRITEABLE PATH FOR FILE UPLOADS ====
  335. - WRITABLE_PATH=/data
  336. #-----------------------------------------------------------------
  337. # ==== OUTGOING WEBHOOKS ====
  338. # What to send to Outgoing Webhook, or leave out. Example, that includes all that are default: cardId,listId,oldListId,boardId,comment,user,card,commentId .
  339. # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  340. #- WEBHOOKS_ATTRIBUTES=
  341. #-----------------------------------------------------------------
  342. # ==== OAUTH2 ORACLE on premise identity manager OIM ====
  343. #- ORACLE_OIM_ENABLED=true
  344. #-----------------------------------------------------------------
  345. # ==== OAUTH2 ONLY WITH OIDC AND DOORKEEPER AS INDENTITY PROVIDER
  346. # https://github.com/wekan/wekan/issues/1874
  347. # https://github.com/wekan/wekan/wiki/OAuth2
  348. # Enable the OAuth2 connection
  349. # example: OAUTH2_ENABLED=true
  350. #- OAUTH2_ENABLED=false
  351. # Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  352. #- OAUTH2_CA_CERT=ABCD1234
  353. # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  354. #- OAUTH2_ADFS_ENABLED=false
  355. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  356. # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  357. # example: OAUTH2_CLIENT_ID=abcde12345
  358. #- OAUTH2_CLIENT_ID=
  359. # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  360. # example: OAUTH2_SECRET=54321abcde
  361. #- OAUTH2_SECRET=
  362. # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  363. # example: OAUTH2_SERVER_URL=https://chat.example.com
  364. #- OAUTH2_SERVER_URL=
  365. # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  366. # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  367. #- OAUTH2_AUTH_ENDPOINT=
  368. # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  369. # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  370. #- OAUTH2_USERINFO_ENDPOINT=
  371. # OAuth2 Token Endpoint. Example: /oauth/token
  372. # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  373. #- OAUTH2_TOKEN_ENDPOINT=
  374. #-----------------------------------------------------------------
  375. # ==== LDAP ====
  376. # https://github.com/wekan/wekan/wiki/LDAP
  377. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  378. # Most settings work both on Snap and Docker below.
  379. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  380. #
  381. # DEFAULT_AUTHENTICATION_METHOD : The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  382. # example : DEFAULT_AUTHENTICATION_METHOD=ldap
  383. #- DEFAULT_AUTHENTICATION_METHOD=
  384. #
  385. # LDAP_ENABLE : Enable or not the connection by the LDAP
  386. # example : LDAP_ENABLE=true
  387. #- LDAP_ENABLE=false
  388. #
  389. # LDAP_PORT : The port of the LDAP server
  390. # example : LDAP_PORT=389
  391. #- LDAP_PORT=389
  392. #
  393. # LDAP_HOST : The host server for the LDAP server
  394. # example : LDAP_HOST=localhost
  395. #- LDAP_HOST=
  396. #
  397. #-----------------------------------------------------------------
  398. # ==== LDAP AD Simple Auth ====
  399. #
  400. # Set to true, if you want to connect with Active Directory by Simple Authentication.
  401. # When using AD Simple Auth, LDAP_BASEDN is not needed.
  402. #- LDAP_AD_SIMPLE_AUTH=true
  403. #
  404. # === Related settings ELSEWHERE IN THIS FILE, NOT HERE ===
  405. #
  406. # Option to login to the LDAP server with the user's own username and password, instead of
  407. # an administrator key. Default: false (use administrator key). When using AD Simple Auth, set to true.
  408. # Set to true, if the login user is used for binding. Used with AD Simple Auth.
  409. # When using AD Simple Auth, LDAP_BASEDN is not needed.
  410. ##ELSEWHERE IN THIS SETTINGS FILE, NOT HERE: #- LDAP_USER_AUTHENTICATION=true
  411. #
  412. # Which field is used to find the user for the user authentication. Default: uid.
  413. ##ELSEWHERE IN THIS SETTINGS FILE, NOT HERE:#- LDAP_USER_AUTHENTICATION_FIELD=uid
  414. #
  415. # === LDAP Default Domain: 2 different use cases, a/b ===
  416. #
  417. # a) The default domain of the ldap it is used to create email if the field is not map
  418. # correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
  419. #
  420. # b) In case AD SimpleAuth is configured, the default domain is appended to the given
  421. # loginname for creating the correct username for the bind request to AD.
  422. #
  423. # Example :
  424. ##ELSEWHERE IN THIS SETTINGS FILE, NOT HERE:- LDAP_DEFAULT_DOMAIN=mydomain.com
  425. #
  426. #-----------------------------------------------------------------
  427. # ==== LDAP BASEDN Auth ====
  428. #
  429. # LDAP_BASEDN : The base DN for the LDAP Tree
  430. # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  431. #- LDAP_BASEDN=
  432. #
  433. #-----------------------------------------------------------------
  434. # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  435. # example : LDAP_LOGIN_FALLBACK=true
  436. #- LDAP_LOGIN_FALLBACK=false
  437. #
  438. # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  439. # example : LDAP_RECONNECT=false
  440. #- LDAP_RECONNECT=true
  441. #
  442. # LDAP_TIMEOUT : Overall timeout, in milliseconds
  443. # example : LDAP_TIMEOUT=12345
  444. #- LDAP_TIMEOUT=10000
  445. #
  446. # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  447. # example : LDAP_IDLE_TIMEOUT=12345
  448. #- LDAP_IDLE_TIMEOUT=10000
  449. #
  450. # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  451. # example : LDAP_CONNECT_TIMEOUT=12345
  452. #- LDAP_CONNECT_TIMEOUT=10000
  453. #
  454. # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  455. # example : LDAP_AUTHENTIFICATION=true
  456. #- LDAP_AUTHENTIFICATION=false
  457. #
  458. # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  459. # example : LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  460. #- LDAP_AUTHENTIFICATION_USERDN=
  461. #
  462. # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  463. # example : AUTHENTIFICATION_PASSWORD=admin
  464. #- LDAP_AUTHENTIFICATION_PASSWORD=
  465. #
  466. # LDAP_LOG_ENABLED : Enable logs for the module
  467. # example : LDAP_LOG_ENABLED=true
  468. #- LDAP_LOG_ENABLED=false
  469. #
  470. # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  471. # example : LDAP_BACKGROUND_SYNC=true
  472. #- LDAP_BACKGROUND_SYNC=false
  473. #
  474. # At which interval does the background task sync.
  475. # The format must be as specified in:
  476. # https://bunkat.github.io/later/parsers.html#text
  477. #- LDAP_BACKGROUND_SYNC_INTERVAL='every 1 hour'
  478. #
  479. # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  480. # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  481. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  482. #
  483. # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  484. # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  485. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  486. #
  487. # LDAP_ENCRYPTION : If using LDAPS
  488. # example : LDAP_ENCRYPTION=ssl
  489. #- LDAP_ENCRYPTION=false
  490. #
  491. # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  492. # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  493. #- LDAP_CA_CERT=
  494. #
  495. # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  496. # example : LDAP_REJECT_UNAUTHORIZED=true
  497. #- LDAP_REJECT_UNAUTHORIZED=false
  498. #
  499. # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  500. # example : LDAP_USER_SEARCH_FILTER=
  501. #- LDAP_USER_SEARCH_FILTER=
  502. #
  503. # 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)
  504. # example : LDAP_USER_SEARCH_SCOPE=one
  505. #- LDAP_USER_SEARCH_SCOPE=
  506. #
  507. # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  508. # example : LDAP_USER_SEARCH_FIELD=uid
  509. #- LDAP_USER_SEARCH_FIELD=
  510. #
  511. # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  512. # example : LDAP_SEARCH_PAGE_SIZE=12345
  513. #- LDAP_SEARCH_PAGE_SIZE=0
  514. #
  515. # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  516. # example : LDAP_SEARCH_SIZE_LIMIT=12345
  517. #- LDAP_SEARCH_SIZE_LIMIT=0
  518. #
  519. # 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
  520. # example : LDAP_GROUP_FILTER_ENABLE=true
  521. #- LDAP_GROUP_FILTER_ENABLE=false
  522. #
  523. # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  524. # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  525. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  526. #
  527. # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE : The attribute of a group identifying it
  528. # example : LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=cn
  529. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  530. #
  531. # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE : The attribute inside a group object listing its members
  532. # example : member
  533. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  534. #
  535. # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT : The format of the value of LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE
  536. # example : dn
  537. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  538. #
  539. # LDAP_GROUP_FILTER_GROUP_NAME : The group name (id) that matches all users
  540. # example : wekan_users
  541. #- LDAP_GROUP_FILTER_GROUP_NAME=
  542. #
  543. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  544. # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  545. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  546. #
  547. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  548. # example : LDAP_UTF8_NAMES_SLUGIFY=false
  549. #- LDAP_UTF8_NAMES_SLUGIFY=true
  550. #
  551. # LDAP_USERNAME_FIELD : Which field contains the ldap username
  552. # example : LDAP_USERNAME_FIELD=username
  553. #- LDAP_USERNAME_FIELD=
  554. #
  555. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname
  556. # example : LDAP_FULLNAME_FIELD=fullname
  557. #- LDAP_FULLNAME_FIELD=
  558. #
  559. # LDAP_MERGE_EXISTING_USERS :
  560. # example : LDAP_MERGE_EXISTING_USERS=true
  561. #- LDAP_MERGE_EXISTING_USERS=false
  562. #
  563. # LDAP_SYNC_USER_DATA :
  564. # example : LDAP_SYNC_USER_DATA=true
  565. #- LDAP_SYNC_USER_DATA=false
  566. #
  567. # LDAP_SYNC_USER_DATA_FIELDMAP :
  568. # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  569. #- LDAP_SYNC_USER_DATA_FIELDMAP=
  570. #
  571. # LDAP_SYNC_GROUP_ROLES :
  572. # example :
  573. #- LDAP_SYNC_GROUP_ROLES=
  574. #
  575. # 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
  576. # example :
  577. #- LDAP_DEFAULT_DOMAIN=
  578. #
  579. #---------------------------------------------------------------------
  580. # ==== LOGOUT TIMER, probably does not work yet ====
  581. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  582. # example : LOGOUT_WITH_TIMER=true
  583. #- LOGOUT_WITH_TIMER=
  584. #
  585. # LOGOUT_IN : The number of days
  586. # example : LOGOUT_IN=1
  587. #- LOGOUT_IN=
  588. #
  589. # LOGOUT_ON_HOURS : The number of hours
  590. # example : LOGOUT_ON_HOURS=9
  591. #- LOGOUT_ON_HOURS=
  592. #
  593. # LOGOUT_ON_MINUTES : The number of minutes
  594. # example : LOGOUT_ON_MINUTES=55
  595. #- LOGOUT_ON_MINUTES=
  596. #---------------------------------------------------------------------
  597. # PASSWORD_LOGIN_ENABLED : Enable or not the password login form.
  598. # example: PASSWORD_LOGIN_ENABLED=false
  599. # - PASSWORD_LOGIN_ENABLED
  600. #-------------------------------------------------------------------
  601. #- CAS_ENABLED=true
  602. #- CAS_BASE_URL=https://cas.example.com/cas
  603. #- CAS_LOGIN_URL=https://cas.example.com/login
  604. #- CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  605. #---------------------------------------------------------------------
  606. #- SAML_ENABLED=true
  607. #- SAML_PROVIDER=
  608. #- SAML_ENTRYPOINT=
  609. #- SAML_ISSUER=
  610. #- SAML_CERT=
  611. #- SAML_IDPSLO_REDIRECTURL=
  612. #- SAML_PRIVATE_KEYFILE=
  613. #- SAML_PUBLIC_CERTFILE=
  614. #- SAML_IDENTIFIER_FORMAT=
  615. #- SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  616. #- SAML_ATTRIBUTES=
  617. #---------------------------------------------------------------------
  618. # Wait spinner to use
  619. #- WAIT_SPINNER=Bounce
  620. #---------------------------------------------------------------------
  621. depends_on:
  622. - mongodb
  623. volumes:
  624. - /etc/localtime:/etc/localtime:ro
  625. - ./volumes/data:/data
  626. #---------------------------------------------------------------------------------
  627. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  628. # When using Wekan both at office LAN and remote VPN:
  629. # 1) Have above Wekan docker container config with LAN IP address
  630. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  631. # before above depends_on: part:
  632. #
  633. # wekan:
  634. # #-------------------------------------------------------------------------------------
  635. # # ==== MONGODB AND METEOR VERSION ====
  636. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  637. #
  638. #
  639. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  640. # address.
  641. # 3) This way both Wekan containers can use same MongoDB database
  642. # and see the same Wekan boards.
  643. # 4) You could also add 3rd Wekan container for 3rd network etc.
  644. # EXAMPLE:
  645. # wekan2:
  646. # ....COPY CONFIG FROM ABOVE TO HERE...
  647. # environment:
  648. # - ROOT_URL='http://10.10.10.10'
  649. # ...COPY CONFIG FROM ABOVE TO HERE...
  650. #---------------------------------------------------------------------------------
  651. volumes:
  652. mongodb:
  653. driver: local
  654. mongodb-dump:
  655. driver: local
  656. networks:
  657. wekan-tier:
  658. driver: bridge