docker-compose.yml 31 KB

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