docker-compose.yml 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731
  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 web browser:
  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 previous 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. services:
  88. wekandb:
  89. #-------------------------------------------------------------------------------------
  90. # ==== MONGODB AND METEOR VERSION ====
  91. # a) mongodb latest, like 3.2 - 4.4 or newer https://hub.docker.com/_/mongo?tab=description
  92. # 2020-12-03:
  93. # - Mongo image copied from Docker Hub mongo:4.4.2-bionic to Quay
  94. # to avoid Docker Hub rate limits.
  95. # Quay image does work:
  96. # image: quay.io/wekan/mongo:4.4.2-bionic
  97. # Docker Hub MongoDB image does work:
  98. image: mongo:4.4
  99. #-------------------------------------------------------------------------------------
  100. container_name: wekan-db
  101. restart: always
  102. # command: mongod --oplogSize 128
  103. # Syslog: mongod --syslog --oplogSize 128 --quiet
  104. # Disable MongoDB logs:
  105. command: mongod --logpath /dev/null --oplogSize 128 --quiet
  106. networks:
  107. - wekan-tier
  108. expose:
  109. - 27017
  110. volumes:
  111. - /etc/localtime:/etc/localtime:ro
  112. - /etc/timezone:/etc/timezone:ro
  113. - wekan-db:/data/db
  114. - wekan-db-dump:/dump
  115. wekan:
  116. #-------------------------------------------------------------------------------------
  117. # ==== MONGODB AND METEOR VERSION ====
  118. # a) Quay automatic builds do work work, https://quay.io/wekan/wekan
  119. image: quay.io/wekan/wekan
  120. # b) Using specific version tag:
  121. # image: quay.io/wekan/wekan:v4.52
  122. # c) Docker Hub builds do work https://hub.docker.com/r/wekanteam/wekan
  123. # image: wekanteam/wekan
  124. #-------------------------------------------------------------------------------------
  125. container_name: wekan-app
  126. restart: always
  127. networks:
  128. - wekan-tier
  129. #-------------------------------------------------------------------------------------
  130. # ==== BUILD wekan-app DOCKER CONTAINER FROM SOURCE, if you uncomment these ====
  131. # ==== and use commands: docker-compose up -d --build
  132. #build:
  133. # context: .
  134. # dockerfile: Dockerfile
  135. #-------------------------------------------------------------------------------------
  136. ports:
  137. # Docker outsideport:insideport. Do not add anything extra here.
  138. # For example, if you want to have wekan on port 3001,
  139. # use 3001:8080 . Do not add any extra address etc here, that way it does not work.
  140. # remove port mapping if you use nginx reverse proxy, port 8080 is already exposed to wekan-tier network
  141. - 80:8080
  142. environment:
  143. - MONGO_URL=mongodb://wekandb:27017/wekan
  144. #---------------------------------------------------------------
  145. # ==== ROOT_URL SETTING ====
  146. # Change ROOT_URL to your real Wekan URL, for example:
  147. # If you have Caddy/Nginx/Apache providing SSL
  148. # - https://example.com
  149. # - https://boards.example.com
  150. # This can be problematic with avatars https://github.com/wekan/wekan/issues/1776
  151. # - https://example.com/wekan
  152. # If without https, can be only wekan node, no need for Caddy/Nginx/Apache if you don't need them
  153. # - http://example.com
  154. # - http://boards.example.com
  155. # - http://192.168.1.100 <=== using at local LAN
  156. - ROOT_URL=http://localhost # <=== using only at same laptop/desktop where Wekan is installed
  157. #---------------------------------------------------------------
  158. # ==== EMAIL SETTINGS ====
  159. # Email settings are only at MAIL_URL and MAIL_FROM.
  160. # Admin Panel has test button, but it's not used for settings.
  161. # see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  162. # For SSL in email, change smtp:// to smtps://
  163. # NOTE: Special characters need to be url-encoded in MAIL_URL.
  164. # You can encode those characters for example at: https://www.urlencoder.org
  165. #- MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  166. - MAIL_URL=smtp://<mail_url>:25/?ignoreTLS=true&tls={rejectUnauthorized:false}
  167. - MAIL_FROM=Wekan Notifications <noreply.wekan@mydomain.com>
  168. # Currently MAIL_SERVICE is not in use.
  169. #- MAIL_SERVICE=Outlook365
  170. #- MAIL_SERVICE_USER=firstname.lastname@hotmail.com
  171. #- MAIL_SERVICE_PASSWORD=SecretPassword
  172. #---------------------------------------------------------------
  173. # https://github.com/wekan/wekan/issues/3585#issuecomment-1021522132
  174. # Add more Node heap, this is done by default at Dockerfile:
  175. # - NODE_OPTIONS="--max_old_space_size=4096"
  176. # Add more stack, this is done at Dockerfile:
  177. # bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js"
  178. #---------------------------------------------------------------
  179. # ==== OPTIONAL: MONGO OPLOG SETTINGS =====
  180. # https://github.com/wekan/wekan-mongodb/issues/2#issuecomment-378343587
  181. # We've fixed our CPU usage problem today with an environment
  182. # change around Wekan. I wasn't aware during implementation
  183. # that if you're using more than 1 instance of Wekan
  184. # (or any MeteorJS based tool) you're supposed to set
  185. # MONGO_OPLOG_URL as an environment variable.
  186. # Without setting it, Meteor will perform a poll-and-diff
  187. # update of it's dataset. With it, Meteor will update from
  188. # the OPLOG. See here
  189. # https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908
  190. # After setting
  191. # MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  192. # the CPU usage for all Wekan instances dropped to an average
  193. # of less than 10% with only occasional spikes to high usage
  194. # (I guess when someone is doing a lot of work)
  195. # - MONGO_OPLOG_URL=mongodb://<username>:<password>@<mongoDbURL>/local?authSource=admin&replicaSet=rsWekan
  196. #---------------------------------------------------------------
  197. # ==== OPTIONAL: KADIRA PERFORMANCE MONITORING FOR METEOR ====
  198. # https://github.com/edemaine/kadira-compose
  199. # https://github.com/meteor/meteor-apm-agent
  200. # https://blog.meteor.com/kadira-apm-is-now-open-source-490469ffc85f
  201. #- APM_OPTIONS_ENDPOINT=http://<kadira-ip>:11011
  202. #- APM_APP_ID=
  203. #- APM_APP_SECRET=
  204. #---------------------------------------------------------------
  205. # ==== OPTIONAL: LOGS AND STATS ====
  206. # https://github.com/wekan/wekan/wiki/Logs
  207. #
  208. # Daily export of Wekan changes as JSON to Logstash and ElasticSearch / Kibana (ELK)
  209. # https://github.com/wekan/wekan-logstash
  210. #
  211. # Statistics Python script for Wekan Dashboard
  212. # https://github.com/wekan/wekan-stats
  213. #
  214. # Console, file, and zulip logger on database changes https://github.com/wekan/wekan/pull/1010
  215. # with fix to replace console.log by winston logger https://github.com/wekan/wekan/pull/1033
  216. # but there could be bug https://github.com/wekan/wekan/issues/1094
  217. #
  218. # There is Feature Request: Logging date and time of all activity with summary reports,
  219. # and requesting reason for changing card to other column https://github.com/wekan/wekan/issues/1598
  220. #---------------------------------------------------------------
  221. # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ====
  222. #- RESULTS_PER_PAGE=20
  223. #---------------------------------------------------------------
  224. # ==== WEKAN API AND EXPORT BOARD ====
  225. # Wekan Export Board works when WITH_API=true.
  226. # https://github.com/wekan/wekan/wiki/REST-API
  227. # https://github.com/wekan/wekan-gogs
  228. # If you disable Wekan API with false, Export Board does not work.
  229. - WITH_API=true
  230. #---------------------------------------------------------------
  231. # ==== PASSWORD BRUTE FORCE PROTECTION ====
  232. #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  233. #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  234. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  235. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  236. #- ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  237. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  238. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  239. #- ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  240. #---------------------------------------------------------------
  241. # ==== ACCOUNT OPTIONS ====
  242. # https://docs.meteor.com/api/accounts-multi.html#AccountsCommon-config
  243. # Defaults below. Uncomment to change. wekan/server/accounts-common.js
  244. # - ACCOUNTS_COMMON_LOGIN_EXPIRATION_IN_DAYS=90
  245. #---------------------------------------------------------------
  246. # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  247. # https://github.com/wekan/wekan/pull/2560
  248. - RICHER_CARD_COMMENT_EDITOR=false
  249. #---------------------------------------------------------------
  250. # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  251. # https://github.com/wekan/wekan/issues/2518
  252. - CARD_OPENED_WEBHOOK_ENABLED=false
  253. #---------------------------------------------------------------
  254. # ==== Allow to shrink attached/pasted image ====
  255. # https://github.com/wekan/wekan/pull/2544
  256. #-MAX_IMAGE_PIXEL=1024
  257. #-IMAGE_COMPRESS_RATIO=80
  258. #---------------------------------------------------------------
  259. # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  260. # Number of days after a notification is read before we remove it.
  261. # Default: 2
  262. #- NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  263. #---------------------------------------------------------------
  264. # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  265. # https://github.com/wekan/wekan/pull/2541
  266. # Introduced a system env var BIGEVENTS_PATTERN default as "NONE",
  267. # so any activityType matches the pattern, system will send out
  268. # notifications to all board members no matter they are watching
  269. # or tracking the board or not. Owner of the wekan server can
  270. # disable the feature by setting this variable to "NONE" or
  271. # change the pattern to any valid regex. i.e. '|' delimited
  272. # activityType names.
  273. # a) Example
  274. #- BIGEVENTS_PATTERN=due
  275. # b) All
  276. #- BIGEVENTS_PATTERN=received|start|due|end
  277. # c) Disabled
  278. - BIGEVENTS_PATTERN=NONE
  279. #---------------------------------------------------------------
  280. # ==== EMAIL DUE DATE NOTIFICATION =====
  281. # https://github.com/wekan/wekan/pull/2536
  282. # System timelines will be showing any user modification for
  283. # dueat startat endat receivedat, also notification to
  284. # the watchers and if any card is due, about due or past due.
  285. #
  286. # Notify due days, default is None, 2 days before and on the event day
  287. #- NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2,0
  288. #
  289. # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  290. # If env variable has parsing error, use default. Notification sent to watchers.
  291. #- NOTIFY_DUE_AT_HOUR_OF_DAY=8
  292. #-----------------------------------------------------------------
  293. # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  294. # Default: 30000 ms = 30s
  295. #- EMAIL_NOTIFICATION_TIMEOUT=30000
  296. #-----------------------------------------------------------------
  297. # ==== CORS =====
  298. # CORS: Set Access-Control-Allow-Origin header.
  299. #- CORS=*
  300. # CORS_ALLOW_HEADERS: Set Access-Control-Allow-Headers header. "Authorization,Content-Type" is required for cross-origin use of the API.
  301. #- CORS_ALLOW_HEADERS=Authorization,Content-Type
  302. # CORS_EXPOSE_HEADERS: Set Access-Control-Expose-Headers header. This is not needed for typical CORS situations
  303. #- CORS_EXPOSE_HEADERS=*
  304. #-----------------------------------------------------------------
  305. # ==== MATOMO INTEGRATION ====
  306. # Optional: Integration with Matomo https://matomo.org that is installed to your server
  307. # The address of the server where Matomo is hosted.
  308. #- MATOMO_ADDRESS=https://example.com/matomo
  309. # The value of the site ID given in Matomo server for Wekan
  310. #- MATOMO_SITE_ID=1
  311. # The option do not track which enables users to not be tracked by matomo
  312. #- MATOMO_DO_NOT_TRACK=true
  313. # The option that allows matomo to retrieve the username:
  314. #- MATOMO_WITH_USERNAME=true
  315. #-----------------------------------------------------------------
  316. # ==== BROWSER POLICY AND TRUSTED IFRAME URL ====
  317. # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  318. # Setting this to false is not recommended, it also disables all other browser policy protections
  319. # and allows all iframing etc. See wekan/server/policy.js
  320. - BROWSER_POLICY_ENABLED=true
  321. # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  322. #- TRUSTED_URL=https://intra.example.com
  323. #-----------------------------------------------------------------
  324. # ==== OUTGOING WEBHOOKS ====
  325. # What to send to Outgoing Webhook, or leave out. If commented out the default values will be: cardId,listId,oldListId,boardId,comment,user,card,commentId,swimlaneId,customerField,customFieldValue
  326. #- WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  327. #-----------------------------------------------------------------
  328. # ==== Debug OIDC OAuth2 etc ====
  329. #- DEBUG=true
  330. #-----------------------------------------------------------------
  331. # ==== OAUTH2 ORACLE on premise identity manager OIM ====
  332. #- ORACLE_OIM_ENABLED=true
  333. #-----------------------------------------------------------------
  334. # ==== OAUTH2 AZURE ====
  335. # https://github.com/wekan/wekan/wiki/Azure
  336. # 1) Register the application with Azure. Make sure you capture
  337. # the application ID as well as generate a secret key.
  338. # 2) Configure the environment variables. This differs slightly
  339. # by installation type, but make sure you have the following:
  340. #- OAUTH2_ENABLED=true
  341. # Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  342. #- OAUTH2_CA_CERT=ABCD1234
  343. # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  344. #- OAUTH2_ADFS_ENABLED=false
  345. # OAuth2 login style: popup or redirect.
  346. #- OAUTH2_LOGIN_STYLE=redirect
  347. # Application GUID captured during app registration:
  348. #- OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  349. # Secret key generated during app registration:
  350. #- OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  351. #- OAUTH2_SERVER_URL=https://login.microsoftonline.com/
  352. #- OAUTH2_AUTH_ENDPOINT=/oauth2/v2.0/authorize
  353. #- OAUTH2_USERINFO_ENDPOINT=https://graph.microsoft.com/oidc/userinfo
  354. #- OAUTH2_TOKEN_ENDPOINT=/oauth2/v2.0/token
  355. # The claim name you want to map to the unique ID field:
  356. #- OAUTH2_ID_MAP=email
  357. # The claim name you want to map to the username field:
  358. #- OAUTH2_USERNAME_MAP=email
  359. # The claim name you want to map to the full name field:
  360. #- OAUTH2_FULLNAME_MAP=name
  361. # The claim name you want to map to the email field:
  362. #- OAUTH2_EMAIL_MAP=email
  363. #-----------------------------------------------------------------
  364. # ==== OAUTH2 Nextcloud ====
  365. # 1) Register the application with Nextcloud: https://your.nextcloud/index.php/settings/admin/security
  366. # Make sure you capture the application ID as well as generate a secret key.
  367. # Use https://your.wekan/_oauth/oidc for the redirect URI.
  368. # 2) Configure the environment variables. This differs slightly
  369. # by installation type, but make sure you have the following:
  370. #- OAUTH2_ENABLED=true
  371. # OAuth2 login style: popup or redirect.
  372. #- OAUTH2_LOGIN_STYLE=redirect
  373. # Application GUID captured during app registration:
  374. #- OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  375. # Secret key generated during app registration:
  376. #- OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  377. #- OAUTH2_SERVER_URL=https://your-nextcloud.tld
  378. #- OAUTH2_AUTH_ENDPOINT=/index.php/apps/oauth2/authorize
  379. #- OAUTH2_USERINFO_ENDPOINT=/ocs/v2.php/cloud/user?format=json
  380. #- OAUTH2_TOKEN_ENDPOINT=/index.php/apps/oauth2/api/v1/token
  381. # The claim name you want to map to the unique ID field:
  382. #- OAUTH2_ID_MAP=id
  383. # The claim name you want to map to the username field:
  384. #- OAUTH2_USERNAME_MAP=id
  385. # The claim name you want to map to the full name field:
  386. #- OAUTH2_FULLNAME_MAP=display-name
  387. # The claim name you want to map to the email field:
  388. #- OAUTH2_EMAIL_MAP=email
  389. #-----------------------------------------------------------------
  390. # ==== OAUTH2 KEYCLOAK ====
  391. # https://github.com/wekan/wekan/wiki/Keycloak <== MAPPING INFO, REQUIRED
  392. #- OAUTH2_ENABLED=true
  393. # OAuth2 login style: popup or redirect.
  394. #- OAUTH2_LOGIN_STYLE=redirect
  395. #- OAUTH2_CLIENT_ID=<Keycloak create Client ID>
  396. #- OAUTH2_SERVER_URL=<Keycloak server name>/auth
  397. #- OAUTH2_AUTH_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/auth
  398. #- OAUTH2_USERINFO_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/userinfo
  399. #- OAUTH2_TOKEN_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/token
  400. #- OAUTH2_SECRET=<keycloak client secret>
  401. #-----------------------------------------------------------------
  402. # ==== OAUTH2 DOORKEEPER ====
  403. # https://github.com/wekan/wekan/issues/1874
  404. # https://github.com/wekan/wekan/wiki/OAuth2
  405. # Enable the OAuth2 connection
  406. #- OAUTH2_ENABLED=true
  407. # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  408. # OAuth2 login style: popup or redirect.
  409. #- OAUTH2_LOGIN_STYLE=redirect
  410. # OAuth2 Client ID.
  411. #- OAUTH2_CLIENT_ID=abcde12345
  412. # OAuth2 Secret.
  413. #- OAUTH2_SECRET=54321abcde
  414. # OAuth2 Server URL.
  415. #- OAUTH2_SERVER_URL=https://chat.example.com
  416. # OAuth2 Authorization Endpoint.
  417. #- OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  418. # OAuth2 Userinfo Endpoint.
  419. #- OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  420. # OAuth2 Token Endpoint.
  421. #- OAUTH2_TOKEN_ENDPOINT=/oauth/token
  422. # OAUTH2 ID Token Whitelist Fields.
  423. #- OAUTH2_ID_TOKEN_WHITELIST_FIELDS=""
  424. # OAUTH2 Request Permissions.
  425. #- OAUTH2_REQUEST_PERMISSIONS=openid profile email
  426. # OAuth2 ID Mapping
  427. #- OAUTH2_ID_MAP=
  428. # OAuth2 Username Mapping
  429. #- OAUTH2_USERNAME_MAP=
  430. # OAuth2 Fullname Mapping
  431. #- OAUTH2_FULLNAME_MAP=
  432. # OAuth2 Email Mapping
  433. #- OAUTH2_EMAIL_MAP=
  434. #-----------------------------------------------------------------
  435. # ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
  436. # https://github.com/wekan/wekan/wiki/LDAP
  437. # For Snap settings see https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys
  438. # Most settings work both on Snap and Docker below.
  439. # Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  440. #
  441. # The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  442. #- DEFAULT_AUTHENTICATION_METHOD=ldap
  443. #
  444. # Enable or not the connection by the LDAP
  445. #- LDAP_ENABLE=true
  446. #
  447. # The port of the LDAP server
  448. #- LDAP_PORT=389
  449. #
  450. # The host server for the LDAP server
  451. #- LDAP_HOST=localhost
  452. #
  453. #-----------------------------------------------------------------
  454. # ==== LDAP AD Simple Auth ====
  455. #
  456. # Set to true, if you want to connect with Active Directory by Simple Authentication.
  457. # When using AD Simple Auth, LDAP_BASEDN is not needed.
  458. #
  459. # Example:
  460. #- LDAP_AD_SIMPLE_AUTH=true
  461. #
  462. # === LDAP User Authentication ===
  463. #
  464. # a) Option to login to the LDAP server with the user's own username and password, instead of
  465. # an administrator key. Default: false (use administrator key).
  466. #
  467. # b) When using AD Simple Auth, set to true, when login user is used for binding,
  468. # and LDAP_BASEDN is not needed.
  469. #
  470. # Example:
  471. #- LDAP_USER_AUTHENTICATION=true
  472. #
  473. # Which field is used to find the user for the user authentication. Default: uid.
  474. #- LDAP_USER_AUTHENTICATION_FIELD=uid
  475. #
  476. # === LDAP Default Domain ===
  477. #
  478. # a) In case AD SimpleAuth is configured, the default domain is appended to the given
  479. # loginname for creating the correct username for the bind request to AD.
  480. #
  481. # b) The default domain of the ldap it is used to create email if the field is not map
  482. # correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
  483. #
  484. # Example :
  485. #- LDAP_DEFAULT_DOMAIN=mydomain.com
  486. #
  487. #-----------------------------------------------------------------
  488. # ==== LDAP BASEDN Auth ====
  489. #
  490. # The base DN for the LDAP Tree
  491. #- LDAP_BASEDN=ou=user,dc=example,dc=org
  492. #
  493. #-----------------------------------------------------------------
  494. # Fallback on the default authentication method
  495. #- LDAP_LOGIN_FALLBACK=false
  496. #
  497. # Reconnect to the server if the connection is lost
  498. #- LDAP_RECONNECT=true
  499. #
  500. # Overall timeout, in milliseconds
  501. #- LDAP_TIMEOUT=10000
  502. #
  503. # Specifies the timeout for idle LDAP connections in milliseconds
  504. #- LDAP_IDLE_TIMEOUT=10000
  505. #
  506. # Connection timeout, in milliseconds
  507. #- LDAP_CONNECT_TIMEOUT=10000
  508. #
  509. # If the LDAP needs a user account to search
  510. #- LDAP_AUTHENTIFICATION=true
  511. #
  512. # The search user DN - You need quotes when you have spaces in parameters
  513. # 2 examples:
  514. #- LDAP_AUTHENTIFICATION_USERDN=CN=ldap admin,CN=users,DC=domainmatter,DC=lan
  515. #- LDAP_AUTHENTIFICATION_USERDN=CN=wekan_adm,OU=serviceaccounts,OU=admin,OU=prod,DC=mydomain,DC=com
  516. #
  517. # The password for the search user
  518. #- LDAP_AUTHENTIFICATION_PASSWORD=pwd
  519. #
  520. # Enable logs for the module
  521. #- LDAP_LOG_ENABLED=true
  522. #
  523. # If the sync of the users should be done in the background
  524. #- LDAP_BACKGROUND_SYNC=false
  525. #
  526. # At which interval does the background task sync.
  527. # The format must be as specified in:
  528. # https://bunkat.github.io/later/parsers.html#text
  529. #- LDAP_BACKGROUND_SYNC_INTERVAL='every 1 hour'
  530. #
  531. #- LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  532. #
  533. #- LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  534. #
  535. # If using LDAPS: LDAP_ENCRYPTION=ssl
  536. #- LDAP_ENCRYPTION=false
  537. #
  538. # The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  539. #- LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+G2FIdAgIC...-----END CERTIFICATE-----
  540. #
  541. # Reject Unauthorized Certificate
  542. #- LDAP_REJECT_UNAUTHORIZED=false
  543. #
  544. # Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  545. #- LDAP_USER_SEARCH_FILTER=
  546. #
  547. # base (search only in the provided DN), one (search only in the provided DN and one level deep), or sub (search the whole subtree)
  548. #- LDAP_USER_SEARCH_SCOPE=one
  549. #
  550. # Which field is used to find the user, like uid / sAMAccountName
  551. #- LDAP_USER_SEARCH_FIELD=sAMAccountName
  552. #
  553. # Used for pagination (0=unlimited)
  554. #- LDAP_SEARCH_PAGE_SIZE=0
  555. #
  556. # The limit number of entries (0=unlimited)
  557. #- LDAP_SEARCH_SIZE_LIMIT=0
  558. #
  559. # Enable group filtering. Note the authenticated ldap user must be able to query all relevant group data with own login data from ldap.
  560. #- LDAP_GROUP_FILTER_ENABLE=false
  561. #
  562. # The object class for filtering. Example: group
  563. #- LDAP_GROUP_FILTER_OBJECTCLASS=
  564. #
  565. # The attribute of a group identifying it. Example: cn
  566. #- LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  567. #
  568. # The attribute inside a group object listing its members. Example: member
  569. #- LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  570. #
  571. # The format of the value of LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE. Example: 'dn' if the users dn is saved as value into the attribute.
  572. #- LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  573. #
  574. # The group name (id) that matches all users.
  575. #- LDAP_GROUP_FILTER_GROUP_NAME=
  576. #
  577. # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier). Example: guid
  578. #- LDAP_UNIQUE_IDENTIFIER_FIELD=
  579. #
  580. # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  581. #- LDAP_UTF8_NAMES_SLUGIFY=true
  582. #
  583. # LDAP_USERNAME_FIELD : Which field contains the ldap username. username / sAMAccountName
  584. #- LDAP_USERNAME_FIELD=sAMAccountName
  585. #
  586. # LDAP_FULLNAME_FIELD : Which field contains the ldap fullname. fullname / sAMAccountName
  587. #- LDAP_FULLNAME_FIELD=fullname
  588. #
  589. #- LDAP_MERGE_EXISTING_USERS=false
  590. #
  591. # Allow existing account matching by e-mail address when username does not match
  592. #- LDAP_EMAIL_MATCH_ENABLE=true
  593. #
  594. # LDAP_EMAIL_MATCH_REQUIRE : require existing account matching by e-mail address when username does match
  595. #- LDAP_EMAIL_MATCH_REQUIRE=true
  596. #
  597. # LDAP_EMAIL_MATCH_VERIFIED : require existing account email address to be verified for matching
  598. #- LDAP_EMAIL_MATCH_VERIFIED=true
  599. #
  600. # LDAP_EMAIL_FIELD : which field contains the LDAP e-mail address
  601. #- LDAP_EMAIL_FIELD=mail
  602. #-----------------------------------------------------------------
  603. #- LDAP_SYNC_USER_DATA=false
  604. #
  605. #- LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  606. #
  607. #- LDAP_SYNC_GROUP_ROLES=
  608. #
  609. # The default domain of the ldap it is used to create email if the field is not map correctly
  610. # with the LDAP_SYNC_USER_DATA_FIELDMAP is defined in setting LDAP_DEFAULT_DOMAIN above.
  611. #
  612. # Enable/Disable syncing of admin status based on ldap groups:
  613. #- LDAP_SYNC_ADMIN_STATUS=true
  614. #
  615. # Comma separated list of admin group names to sync.
  616. #- LDAP_SYNC_ADMIN_GROUPS=group1,group2
  617. #---------------------------------------------------------------------
  618. # Login to LDAP automatically with HTTP header.
  619. # In below example for siteminder, at right side of = is header name.
  620. #- HEADER_LOGIN_ID=HEADERUID
  621. #- HEADER_LOGIN_FIRSTNAME=HEADERFIRSTNAME
  622. #- HEADER_LOGIN_LASTNAME=HEADERLASTNAME
  623. #- HEADER_LOGIN_EMAIL=HEADEREMAILADDRESS
  624. #---------------------------------------------------------------------
  625. # ==== LOGOUT TIMER, probably does not work yet ====
  626. # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  627. # example : LOGOUT_WITH_TIMER=true
  628. #- LOGOUT_WITH_TIMER=
  629. #
  630. # LOGOUT_IN : The number of days
  631. # example : LOGOUT_IN=1
  632. #- LOGOUT_IN=
  633. #
  634. # LOGOUT_ON_HOURS : The number of hours
  635. # example : LOGOUT_ON_HOURS=9
  636. #- LOGOUT_ON_HOURS=
  637. #
  638. # LOGOUT_ON_MINUTES : The number of minutes
  639. # example : LOGOUT_ON_MINUTES=55
  640. #- LOGOUT_ON_MINUTES=
  641. #-------------------------------------------------------------------
  642. # Hide password login form
  643. # - PASSWORD_LOGIN_ENABLED=true
  644. #-------------------------------------------------------------------
  645. #- CAS_ENABLED=true
  646. #- CAS_BASE_URL=https://cas.example.com/cas
  647. #- CAS_LOGIN_URL=https://cas.example.com/login
  648. #- CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  649. #---------------------------------------------------------------------
  650. #- SAML_ENABLED=true
  651. #- SAML_PROVIDER=
  652. #- SAML_ENTRYPOINT=
  653. #- SAML_ISSUER=
  654. #- SAML_CERT=
  655. #- SAML_IDPSLO_REDIRECTURL=
  656. #- SAML_PRIVATE_KEYFILE=
  657. #- SAML_PUBLIC_CERTFILE=
  658. #- SAML_IDENTIFIER_FORMAT=
  659. #- SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  660. #- SAML_ATTRIBUTES=
  661. #---------------------------------------------------------------------
  662. # Wait spinner to use
  663. # - WAIT_SPINNER=Bounce
  664. #---------------------------------------------------------------------
  665. depends_on:
  666. - wekandb
  667. volumes:
  668. - /etc/localtime:/etc/localtime:ro
  669. #---------------------------------------------------------------------------------
  670. # ==== OPTIONAL: SHARE DATABASE TO OFFICE LAN AND REMOTE VPN ====
  671. # When using Wekan both at office LAN and remote VPN:
  672. # 1) Have above Wekan docker container config with LAN IP address
  673. # 2) Copy all of above wekan container config below, look above of this part above and all config below it,
  674. # before above depends_on: part:
  675. #
  676. # wekan:
  677. # #-------------------------------------------------------------------------------------
  678. # # ==== MONGODB AND METEOR VERSION ====
  679. # # a) For Wekan Meteor 1.8.x version at meteor-1.8 branch, .....
  680. #
  681. #
  682. # and change name to different name like wekan2 or wekanvpn, and change ROOT_URL to server VPN IP
  683. # address.
  684. # 3) This way both Wekan containers can use same MongoDB database
  685. # and see the same Wekan boards.
  686. # 4) You could also add 3rd Wekan container for 3rd network etc.
  687. # EXAMPLE:
  688. # wekan2:
  689. # ....COPY CONFIG FROM ABOVE TO HERE...
  690. # environment:
  691. # - ROOT_URL='http://10.10.10.10'
  692. # ...COPY CONFIG FROM ABOVE TO HERE...
  693. #---------------------------------------------------------------------------------
  694. # OPTIONAL NGINX CONFIG FOR REVERSE PROXY
  695. # nginx:
  696. # image: nginx
  697. # container_name: nginx
  698. # restart: always
  699. # networks:
  700. # - wekan-tier
  701. # depends_on:
  702. # - wekan
  703. # ports:
  704. # - 80:80
  705. # - 443:443
  706. # volumes:
  707. # - ./nginx/ssl:/etc/nginx/ssl/:ro
  708. # - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
  709. ## Alternative volume config:
  710. ## volumes:
  711. ## - ./nginx/nginx.conf:/etc/nginx/conf.d/default.conf:ro
  712. ## - ./nginx/ssl/ssl.conf:/etc/nginx/conf.d/ssl/ssl.conf:ro
  713. ## - ./nginx/ssl/testvm-ehu.crt:/etc/nginx/conf.d/ssl/certs/mycert.crt:ro
  714. ## - ./nginx/ssl/testvm-ehu.key:/etc/nginx/conf.d/ssl/certs/mykey.key:ro
  715. ## - ./nginx/ssl/pphrase:/etc/nginx/conf.d/ssl/pphrase:ro
  716. volumes:
  717. wekan-db:
  718. driver: local
  719. wekan-db-dump:
  720. driver: local
  721. networks:
  722. wekan-tier:
  723. driver: bridge