start-wekan.bat 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650
  1. @ECHO OFF
  2. REM # ------------------- HOWTO ---------------------
  3. REM # https://github.com/wekan/wekan/wiki/Offline
  4. REM #-------------------- REQUIRED SETTINGS START --------------------
  5. REM # Writable path required to exist and be writable for attachments to migrate and work correctly
  6. SET WRITABLE_PATH=..
  7. REM # MongoDB database URL required
  8. SET MONGO_URL=mongodb://127.0.0.1:27017/wekan
  9. REM # If port is 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS , like http://192.168.0.100
  10. REM # If port is not 80, must change ROOT_URL to: http://YOUR-WEKAN-SERVER-IPv4-ADDRESS:YOUR-PORT-NUMBER , like http://192.168.0.100:2000
  11. REM # If ROOT_URL is not correct, these do not work: translations, uploading attachments.
  12. SET ROOT_URL=http://localhost
  13. REM # Must change to YOUR-PORT-NUMBER:
  14. SET PORT=80
  15. REM #------------------- REQUIRED SETTINGS END ----------------------
  16. REM #-------------------- OPTIONAL SETTINGS START -------------------
  17. REM # If at public Internet, required different settings:
  18. REM # - For ROOT_URL: https://github.com/wekan/wekan/wiki/Settings
  19. REM # - For SSL/TLS, also at above wiki right menu: config for Caddy/Nginx/Apache
  20. REM ------------------------------------------------------------
  21. REM # Debug OIDC OAuth2 etc.
  22. REM SET DEBUG=true
  23. REM ------------------------------------------------------------
  24. REM # ==== AWS S3 FOR FILES ====
  25. REM # Any region. For example:
  26. REM # us-standard,us-west-1,us-west-2,
  27. REM # eu-west-1,eu-central-1,
  28. REM # ap-southeast-1,ap-northeast-1,sa-east-1
  29. REM #
  30. REM SET S3='{"s3":{"key": "xxx", "secret": "xxx", "bucket": "xxx", "region": "eu-west-1"}}'
  31. REM # https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
  32. REM SET MAIL_URL=smtps://username:password@email-smtp.eu-west-1.amazonaws.com:587/
  33. REM SET MAIL_FROM="Wekan Boards <info@example.com>"
  34. REM # Currently MAIL_SERVICE is not in use.
  35. REM SET MAIL_SERVICE=Outlook365
  36. REM SET MAIL_SERVICE_USER=firstname.lastname@hotmail.com
  37. REM SET MAIL_SERVICE_PASSWORD=SecretPassword
  38. REM # ==== NUMBER OF SEARCH RESULTS PER PAGE BY DEFAULT ====
  39. REM SET RESULTS_PER_PAGE=20
  40. REM # If you disable Wekan API with false, Export Board does not work.
  41. SET WITH_API=true
  42. REM # ==== AFTER OIDC LOGIN, ADD USERS AUTOMATICALLY TO THIS BOARD ID ====
  43. REM # https://github.com/wekan/wekan/pull/5098
  44. REM SET DEFAULT_BOARD_ID=abcd1234
  45. REM # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  46. REM # https://github.com/wekan/wekan/pull/2560
  47. SET RICHER_CARD_COMMENT_EDITOR=false
  48. REM # ==== CARD OPENED, SEND WEBHOOK MESSAGE ====
  49. SET CARD_OPENED_WEBHOOK_ENABLED=false
  50. REM # ==== Allow to shrink attached/pasted image ====
  51. REM # https://github.com/wekan/wekan/pull/2544
  52. REM SET MAX_IMAGE_PIXEL=1024
  53. REM SET IMAGE_COMPRESS_RATIO=80
  54. REM # ==== PASSWORD BRUTE FORCE PROTECTION ====
  55. REM #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  56. REM #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  57. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  58. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  59. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  60. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  61. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  62. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  63. REM # ==== ACCOUNT OPTIONS ====
  64. REM SET ACCOUNTS_COMMON_LOGIN_EXPIRATION_IN_DAYS=90
  65. REM # ==== Allow configuration to validate uploaded attachments ====
  66. REM SET ATTACHMENTS_UPLOAD_EXTERNAL_PROGRAM="avscan {file}"
  67. REM SET ATTACHMENTS_UPLOAD_MIME_TYPES="image/*,text/*"
  68. REM SET ATTACHMENTS_UPLOAD_MAX_SIZE=5000000
  69. REM # ==== Allow configuration to validate uploaded avatars ====
  70. REM SET AVATARS_UPLOAD_EXTERNAL_PROGRAM="avscan {file}"
  71. REM SET AVATARS_UPLOAD_MIME_TYPES="image/*"
  72. REM SET AVATARS_UPLOAD_MAX_SIZE=500000
  73. REM # ==== NOTIFICATION TRAY AFTER READ DAYS BEFORE REMOVE =====
  74. REM # Number of days after a notification is read before we remove it.
  75. REM # Default: 2
  76. REM SET NOTIFICATION_TRAY_AFTER_READ_DAYS_BEFORE_REMOVE=2
  77. REM # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  78. REM # https://github.com/wekan/wekan/pull/2541
  79. REM # Introduced a system env var BIGEVENTS_PATTERN default as "NONE",
  80. REM # so any activityType matches the pattern, system will send out
  81. REM # notifications to all board members no matter they are watching
  82. REM # or tracking the board or not. Owner of the wekan server can
  83. REM # disable the feature by setting this variable to "NONE" or
  84. REM # change the pattern to any valid regex. i.e. '|' delimited
  85. REM # activityType names.
  86. REM # a) Example
  87. REM SET BIGEVENTS_PATTERN=due
  88. REM # b) All
  89. REM SET BIGEVENTS_PATTERN=received|start|due|end
  90. REM # c) Disabled
  91. SET BIGEVENTS_PATTERN=NONE
  92. REM # ==== EMAIL DUE DATE NOTIFICATION =====
  93. REM # https://github.com/wekan/wekan/pull/2536
  94. REM # System timelines will be showing any user modification for
  95. REM # dueat startat endat receivedat, also notification to
  96. REM # the watchers and if any card is due, about due or past due.
  97. REM # Notify due days, default is None.
  98. REM # SET NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2,0
  99. REM # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  100. REM # If env variable has parsing error, use default. Notification sent to watchers.
  101. REM SET NOTIFY_DUE_AT_HOUR_OF_DAY=8
  102. REM # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  103. REM # Defaut: 30000 ms = 30s
  104. REM SET EMAIL_NOTIFICATION_TIMEOUT=30000
  105. REM # CORS: Set Access-Control-Allow-Origin header. Example: *
  106. REM SET CORS=*
  107. REM # To enable the Set Access-Control-Allow-Headers header. "Authorization,Content-Type" is required for cross-origin use of the API.
  108. REM SET CORS_ALLOW_HEADERS=Authorization,Content-Type
  109. REM # To enable the Set Access-Control-Expose-Headers header. This is not needed for typical CORS situations. Example: *
  110. REM SET CORS_EXPOSE_HEADERS=*
  111. REM # Optional: Integration with Matomo https://matomo.org that is installed to your server
  112. REM # The address of the server where Matomo is hosted.
  113. REM # example: - MATOMO_ADDRESS=https://example.com/matomo
  114. REM SET MATOMO_ADDRESS=
  115. REM # ==== METRICS ALLOWED IP ADDRESSES ====
  116. REM # https://github.com/wekan/wekan/wiki/Metrics
  117. REM SET METRICS_ALLOWED_IP_ADDRESSES=192.168.0.100,192.168.0.200
  118. REM # The value of the site ID given in Matomo server for Wekan
  119. REM # example: - MATOMO_SITE_ID=12345
  120. REM SET MATOMO_SITE_ID=
  121. REM # The option do not track which enables users to not be tracked by matomo
  122. REM # example: - MATOMO_DO_NOT_TRACK=false
  123. REM SET MATOMO_DO_NOT_TRACK=
  124. REM # The option that allows matomo to retrieve the username:
  125. REM # example: MATOMO_WITH_USERNAME=true
  126. REM SET MATOMO_WITH_USERNAME=false
  127. REM # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  128. REM # Setting this to false is not recommended, it also disables all other browser policy protections
  129. REM # and allows all iframing etc. See wekan/server/policy.js
  130. SET BROWSER_POLICY_ENABLED=true
  131. REM # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  132. REM SET TRUSTED_URL=
  133. REM # What to send to Outgoing Webhook, or leave out. Example, that includes all that are default: cardId,listId,oldListId,boardId,comment,user,card,commentId .
  134. REM # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  135. REM SET WEBHOOKS_ATTRIBUTES=
  136. REM ------------------------------------------------------------
  137. REM ## ==== AUTOLOGIN WITH OIDC/OAUTH2 ====
  138. REM ## https://github.com/wekan/wekan/wiki/autologin
  139. REM # SET OIDC_REDIRECTION_ENABLED=true
  140. REM ------------------------------------------------------------
  141. REM # OAUTH2 ORACLE on premise identity manager OIM
  142. REM SET ORACLE_OIM_ENABLED=true
  143. REM ------------------------------------------------------------
  144. REM ## ==== OAUTH2 AZURE ====
  145. REM ## https://github.com/wekan/wekan/wiki/Azure
  146. REM ## 1) Register the application with Azure. Make sure you capture
  147. REM ## the application ID as well as generate a secret key.
  148. REM ## 2) Configure the environment variables. This differs slightly
  149. REM ## by installation type, but make sure you have the following:
  150. REM SET OAUTH2_ENABLED=true
  151. REM ## Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  152. REM # SET OAUTH2_CA_CERT=ABCD1234
  153. REM ## Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  154. REM # SET OAUTH2_ADFS_ENABLED=false
  155. REM ## Azure AD B2C. https://github.com/wekan/wekan/issues/5242
  156. REM # SET OAUTH2_B2C_ENABLED=false
  157. REM ## OAuth2 login style: popup or redirect.
  158. REM SET OAUTH2_LOGIN_STYLE=popup
  159. REM ## Application GUID captured during app registration:
  160. REM SET OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  161. REM ## Secret key generated during app registration:
  162. REM SET OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  163. REM SET OAUTH2_SERVER_URL=https://login.microsoftonline.com/
  164. REM SET OAUTH2_AUTH_ENDPOINT=/oauth2/v2.0/authorize
  165. REM SET OAUTH2_USERINFO_ENDPOINT=https://graph.microsoft.com/oidc/userinfo
  166. REM SET OAUTH2_TOKEN_ENDPOINT=/oauth2/v2.0/token
  167. REM ## The claim name you want to map to the unique ID field:
  168. REM SET OAUTH2_ID_MAP=email
  169. REM ## The claim name you want to map to the username field:
  170. REM SET OAUTH2_USERNAME_MAP=email
  171. REM ## The claim name you want to map to the full name field:
  172. REM SET OAUTH2_FULLNAME_MAP=name
  173. REM ## The claim name you want to map to the email field:
  174. REM SET OAUTH2_EMAIL_MAP=email
  175. REM ------------------------------------------------------------
  176. REM ## ==== OAUTH2 Nextcloud ====
  177. REM ## 1) Register the application with Nextcloud: https://your.nextcloud/index.php/settings/admin/security
  178. REM ## Make sure you capture the application ID as well as generate a secret key.
  179. REM ## Use https://your.wekan/_oauth/oidc for the redirect URI.
  180. REM ## 2) Configure the environment variables. This differs slightly
  181. REM ## by installation type, but make sure you have the following:
  182. REM SET OAUTH2_ENABLED=true
  183. REM ## OAuth2 login style: popup or redirect.
  184. REM SET OAUTH2_LOGIN_STYLE=popup
  185. REM ## Application GUID captured during app registration:
  186. REM SET OAUTH2_CLIENT_ID=xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
  187. REM ## Secret key generated during app registration:
  188. REM SET OAUTH2_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  189. REM SET OAUTH2_SERVER_URL=https://your-nextcloud.tld
  190. REM SET OAUTH2_AUTH_ENDPOINT=/index.php/apps/oauth2/authorize
  191. REM SET OAUTH2_USERINFO_ENDPOINT=/ocs/v2.php/cloud/user?format=json
  192. REM SET OAUTH2_TOKEN_ENDPOINT=/index.php/apps/oauth2/api/v1/token
  193. REM ## The claim name you want to map to the unique ID field:
  194. REM SET OAUTH2_ID_MAP=id
  195. REM ## The claim name you want to map to the username field:
  196. REM SET OAUTH2_USERNAME_MAP=id
  197. REM ## The claim name you want to map to the full name field:
  198. REM SET OAUTH2_FULLNAME_MAP=display-name
  199. REM ## The claim name you want to map to the email field:
  200. REM SET OAUTH2_EMAIL_MAP=email
  201. REM ------------------------------------------------------------
  202. REM ## ==== OAUTH2 KEYCLOAK ====
  203. REM ## https://github.com/wekan/wekan/wiki/Keycloak <== MAPPING INFO, REQUIRED
  204. REM SET OAUTH2_ENABLED=true
  205. REM ## OAuth2 login style: popup or redirect.
  206. REM SET OAUTH2_LOGIN_STYLE=popup
  207. REM SET OAUTH2_CLIENT_ID=<Keycloak create Client ID>
  208. REM SET OAUTH2_SERVER_URL=<Keycloak server url - https://keycloak.example.com>
  209. REM SET OAUTH2_AUTH_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/auth
  210. REM SET OAUTH2_USERINFO_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/userinfo
  211. REM SET OAUTH2_TOKEN_ENDPOINT=/realms/<keycloak realm>/protocol/openid-connect/token
  212. REM SET OAUTH2_SECRET=<keycloak client secret>
  213. REM SET OAUTH2_ID_MAP=sub
  214. REM SET OAUTH2_USERNAME_MAP=preferred_username
  215. REM SET OAUTH2_EMAIL_MAP=email
  216. REM SET OAUTH2_FULLNAME_MAP=name
  217. REM ------------------------------------------------------------
  218. REM ## ==== OAUTH2 DOORKEEPER ====
  219. REM ## https://github.com/wekan/wekan/issues/1874
  220. REM ## https://github.com/wekan/wekan/wiki/OAuth2
  221. REM ## Enable the OAuth2 connection
  222. REM SET OAUTH2_ENABLED=true
  223. REM ## OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  224. REM ## OAuth2 login style: popup or redirect.
  225. REM SET OAUTH2_LOGIN_STYLE=popup
  226. REM ## OAuth2 Client ID.
  227. REM SET OAUTH2_CLIENT_ID=abcde12345
  228. REM ## OAuth2 Secret.
  229. REM SET OAUTH2_SECRET=54321abcde
  230. REM ## OAuth2 Server URL.
  231. REM SET OAUTH2_SERVER_URL=https://chat.example.com
  232. REM ## OAuth2 Authorization Endpoint.
  233. REM SET OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  234. REM ## OAuth2 Userinfo Endpoint.
  235. REM SET OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  236. REM ## OAuth2 Token Endpoint.
  237. REM SET OAUTH2_TOKEN_ENDPOINT=/oauth/token
  238. REM ## OAUTH2 ID Token Whitelist Fields.
  239. REM SET OAUTH2_ID_TOKEN_WHITELIST_FIELDS=""
  240. REM ## OAUTH2 Request Permissions.
  241. REM SET OAUTH2_REQUEST_PERMISSIONS=openid profile email
  242. REM ## OAuth2 ID Mapping
  243. REM # SET OAUTH2_ID_MAP=
  244. REM ## OAuth2 Username Mapping
  245. REM # SET OAUTH2_USERNAME_MAP=
  246. REM ## OAuth2 Fullname Mapping
  247. REM # SET OAUTH2_FULLNAME_MAP=
  248. REM ## OAuth2 Email Mapping
  249. REM # SET OAUTH2_EMAIL_MAP=
  250. REM ------------------------------------------------------------
  251. REM # Enable the OAuth2 connection
  252. REM # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  253. REM # example: OAUTH2_ENABLED=true
  254. REM SET OAUTH2_ENABLED=false
  255. REM # Optional OAuth2 CA Cert, see https://github.com/wekan/wekan/issues/3299
  256. REM SET OAUTH2_CA_CERT=ABCD1234
  257. REM # Use OAuth2 ADFS additional changes. Also needs OAUTH2_ENABLED=true setting.
  258. REM SET OAUTH2_ADFS_ENABLED=false
  259. REM # Use OAuth2 Azure AD B2C. Also requires OAUTH2_ENABLED=true setting . https://github.com/wekan/wekan/issues/5242
  260. REM SET DEFAULT_OAUTH2_B2C_ENABLED=false
  261. REM # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  262. REM # example: OAUTH2_CLIENT_ID=abcde12345
  263. REM SET OAUTH2_CLIENT_ID=
  264. REM # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  265. REM # example: OAUTH2_SECRET=54321abcde
  266. REM SET OAUTH2_SECRET=
  267. REM # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  268. REM # example: OAUTH2_SERVER_URL=https://chat.example.com
  269. REM SET OAUTH2_SERVER_URL=
  270. REM # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  271. REM # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  272. REM SET OAUTH2_AUTH_ENDPOINT=
  273. REM # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  274. REM # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  275. REM SET OAUTH2_USERINFO_ENDPOINT=
  276. REM # OAuth2 Token Endpoint. Example: /oauth/token
  277. REM # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  278. REM SET OAUTH2_TOKEN_ENDPOINT=
  279. REM # OAUTH2 ID Token Whitelist Fields.
  280. REM SET OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[]
  281. REM # OAUTH2 Request Permissions.
  282. REM SET OAUTH2_REQUEST_PERMISSIONS=openid profile email
  283. REM # OAuth2 ID Mapping
  284. REM SET OAUTH2_ID_MAP=
  285. REM # OAuth2 Username Mapping
  286. REM SET OAUTH2_USERNAME_MAP=
  287. REM # OAuth2 Fullname Mapping
  288. REM SET OAUTH2_FULLNAME_MAP=
  289. REM # OAuth2 Email Mapping
  290. REM SET OAUTH2_EMAIL_MAP=
  291. REM ------------------------------------------------------------
  292. REM ## ==== LDAP: UNCOMMENT ALL TO ENABLE LDAP ====
  293. REM ## https://github.com/wekan/wekan/wiki/LDAP
  294. REM ## Note: Do not add single quotes '' to variables. Having spaces still works without quotes where required.
  295. REM # The default authentication method used if a user does not exist to create and authenticate. Can be set as ldap.
  296. REM # (this is set properly in the Admin Panel, changing this item does not remove Password login option)
  297. REM SET DEFAULT_AUTHENTICATION_METHOD=ldap
  298. REM # LDAP_ENABLE : Enable or not the connection by the LDAP
  299. REM SET LDAP_ENABLE=true
  300. REM # LDAP_PORT : The port of the LDAP server
  301. REM SET LDAP_PORT=389
  302. REM # LDAP_HOST : The host server for the LDAP server
  303. REM SET LDAP_HOST=localhost
  304. REM #-----------------------------------------------------------------
  305. REM # ==== LDAP AD Simple Auth ====
  306. REM # Set to true, if you want to connect with Active Directory by Simple Authentication.
  307. REM # When using AD Simple Auth, LDAP_BASEDN is not needed.
  308. REM SET LDAP_AD_SIMPLE_AUTH=true
  309. REM #-----------------------------------------------------------------
  310. REM # === LDAP User Authentication ===
  311. REM #
  312. REM # a) Option to login to the LDAP server with the user's own username and password, instead of
  313. REM # an administrator key. Default: false (use administrator key).
  314. REM #
  315. REM # b) When using AD Simple Auth, set to true, when login user is used for binding,
  316. REM # and LDAP_BASEDN is not needed.
  317. REM #
  318. REM # Example:
  319. REM SET LDAP_USER_AUTHENTICATION=true
  320. REM # Which field is used to find the user for the user authentication. Default: uid.
  321. REM SET LDAP_USER_AUTHENTICATION_FIELD=uid
  322. REM # === LDAP Default Domain ===
  323. REM #
  324. REM # a) In case AD SimpleAuth is configured, the default domain is appended to the given
  325. REM # loginname for creating the correct username for the bind request to AD.
  326. REM #
  327. REM # b) The default domain of the ldap it is used to create email if the field is not map
  328. REM # correctly with the LDAP_SYNC_USER_DATA_FIELDMAP
  329. REM #
  330. REM # Example :
  331. REM SET LDAP_DEFAULT_DOMAIN=mydomain.com
  332. REM #-----------------------------------------------------------------
  333. REM # ==== LDAP BASEDN Auth ====
  334. REM # LDAP_BASEDN : The base DN for the LDAP Tree
  335. REM # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  336. REM SET LDAP_BASEDN=
  337. REM #-----------------------------------------------------------------
  338. REM # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  339. REM # example : LDAP_LOGIN_FALLBACK=true
  340. REM SET LDAP_LOGIN_FALLBACK=false
  341. REM # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  342. REM # example : LDAP_RECONNECT=false
  343. REM SET LDAP_RECONNECT=true
  344. REM # LDAP_TIMEOUT : Overall timeout, in milliseconds
  345. REM # example : LDAP_TIMEOUT=12345
  346. REM SET LDAP_TIMEOUT=10000
  347. REM # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  348. REM # example : LDAP_IDLE_TIMEOUT=12345
  349. REM SET LDAP_IDLE_TIMEOUT=10000
  350. REM # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  351. REM # example : LDAP_CONNECT_TIMEOUT=12345
  352. REM SET LDAP_CONNECT_TIMEOUT=10000
  353. REM # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  354. REM # example : LDAP_AUTHENTIFICATION=true
  355. REM SET LDAP_AUTHENTIFICATION=false
  356. REM # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  357. REM # example: LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  358. REM SET LDAP_AUTHENTIFICATION_USERDN=
  359. REM # The search user DN - You need quotes when you have spaces in parameters
  360. REM # 2 examples:
  361. REM SET LDAP_AUTHENTIFICATION_USERDN="CN=ldap admin,CN=users,DC=domainmatter,DC=lan"
  362. REM SET LDAP_AUTHENTIFICATION_USERDN="CN=wekan_adm,OU=serviceaccounts,OU=admin,OU=prod,DC=mydomain,DC=com"
  363. REM # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  364. REM # example : AUTHENTIFICATION_PASSWORD=admin
  365. REM SET LDAP_AUTHENTIFICATION_PASSWORD=
  366. REM # LDAP_LOG_ENABLED : Enable logs for the module
  367. REM # example : LDAP_LOG_ENABLED=true
  368. REM SET LDAP_LOG_ENABLED=false
  369. REM # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  370. REM # example : LDAP_BACKGROUND_SYNC=true
  371. REM SET LDAP_BACKGROUND_SYNC=false
  372. REM # LDAP_BACKGROUND_SYNC_INTERVAL : At which interval does the background task sync in milliseconds
  373. REM # The format must be as specified in:
  374. REM # https://bunkat.github.io/later/parsers.html#text
  375. REM SET LDAP_BACKGROUND_SYNC_INTERVAL=every 1 hours
  376. REM # At which interval does the background task sync in milliseconds.
  377. REM # Leave this unset, so it uses default, and does not crash.
  378. REM # https://github.com/wekan/wekan/issues/2354#issuecomment-515305722
  379. SET LDAP_BACKGROUND_SYNC_INTERVAL=''
  380. REM # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  381. REM # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  382. REM SET LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  383. REM # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  384. REM # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  385. REM SET LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  386. REM # LDAP_ENCRYPTION : If using LDAPS
  387. REM # example : LDAP_ENCRYPTION=ssl
  388. REM SET LDAP_ENCRYPTION=false
  389. REM # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  390. REM # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  391. REM SET LDAP_CA_CERT=
  392. REM # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  393. REM # example : LDAP_REJECT_UNAUTHORIZED=true
  394. REM SET LDAP_REJECT_UNAUTHORIZED=false
  395. REM # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  396. REM # example : LDAP_USER_SEARCH_FILTER=
  397. REM SET LDAP_USER_SEARCH_FILTER=
  398. REM # 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)
  399. REM # example : LDAP_USER_SEARCH_SCOPE=one
  400. REM SET LDAP_USER_SEARCH_SCOPE=
  401. REM # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  402. REM # example : LDAP_USER_SEARCH_FIELD=uid
  403. REM SET LDAP_USER_SEARCH_FIELD=
  404. REM # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  405. REM # example : LDAP_SEARCH_PAGE_SIZE=12345
  406. REM SET LDAP_SEARCH_PAGE_SIZE=0
  407. REM # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  408. REM #33 example : LDAP_SEARCH_SIZE_LIMIT=12345
  409. REM SET LDAP_SEARCH_SIZE_LIMIT=0
  410. REM # LDAP_GROUP_FILTER_ENABLE : Enable group filtering
  411. REM # example : LDAP_GROUP_FILTER_ENABLE=true
  412. REM SET LDAP_GROUP_FILTER_ENABLE=false
  413. REM # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  414. REM # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  415. REM SET LDAP_GROUP_FILTER_OBJECTCLASS=
  416. REM # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE :
  417. REM # example :
  418. REM SET LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  419. REM # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE :
  420. REM # example :
  421. REM SET LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  422. REM # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT :
  423. REM # example :
  424. REM SET LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  425. REM # LDAP_GROUP_FILTER_GROUP_NAME :
  426. REM # example :
  427. REM SET LDAP_GROUP_FILTER_GROUP_NAME=
  428. REM # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  429. REM # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  430. REM SET LDAP_UNIQUE_IDENTIFIER_FIELD=
  431. REM # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  432. REM # example : LDAP_UTF8_NAMES_SLUGIFY=false
  433. REM SET LDAP_UTF8_NAMES_SLUGIFY=true
  434. REM # LDAP_USERNAME_FIELD : Which field contains the ldap username
  435. REM # example : LDAP_USERNAME_FIELD=username
  436. REM SET LDAP_USERNAME_FIELD=
  437. REM # LDAP_MERGE_EXISTING_USERS :
  438. REM # example : LDAP_MERGE_EXISTING_USERS=true
  439. REM SET LDAP_MERGE_EXISTING_USERS=false
  440. REM # LDAP_EMAIL_MATCH_ENABLE : allow existing account matching by e-mail address when username does not match
  441. REM # example: LDAP_EMAIL_MATCH_ENABLE=true
  442. REM SET LDAP_EMAIL_MATCH_ENABLE=false
  443. REM # LDAP_EMAIL_MATCH_REQUIRE : require existing account matching by e-mail address when username does match
  444. REM # example: LDAP_EMAIL_MATCH_REQUIRE=true
  445. REM SET LDAP_EMAIL_MATCH_REQUIRE=false
  446. REM # LDAP_EMAIL_MATCH_VERIFIED : require existing account email address to be verified for matching
  447. REM # example: LDAP_EMAIL_MATCH_VERIFIED=true
  448. REM SET LDAP_EMAIL_MATCH_VERIFIED=false
  449. REM # LDAP_EMAIL_FIELD : which field contains the LDAP e-mail address
  450. REM # example: LDAP_EMAIL_FIELD=mail
  451. REM SET LDAP_EMAIL_FIELD=
  452. REM # LDAP_SYNC_USER_DATA :
  453. REM # example : LDAP_SYNC_USER_DATA=true
  454. REM SET LDAP_SYNC_USER_DATA=false
  455. REM # LDAP_SYNC_USER_DATA_FIELDMAP :
  456. REM # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  457. REM SET LDAP_SYNC_USER_DATA_FIELDMAP=
  458. REM # The default domain of the ldap it is used to create email if the field is not map correctly
  459. REM # with the LDAP_SYNC_USER_DATA_FIELDMAP is defined in setting LDAP_DEFAULT_DOMAIN above.
  460. REM # LDAP_SYNC_GROUP_ROLES :
  461. REM # example :
  462. REM # SET LDAP_SYNC_GROUP_ROLES=
  463. REM # Enable/Disable syncing of admin status based on ldap groups:
  464. REM SET LDAP_SYNC_ADMIN_STATUS=true
  465. REM # Comma separated list of admin group names to sync.
  466. REM SET LDAP_SYNC_ADMIN_GROUPS=group1,group2
  467. REM ------------------------------------------------
  468. REM # Enable/Disable password login form.
  469. REM SET PASSWORD_LOGIN_ENABLED=true
  470. REM ------------------------------------------------
  471. REM # Login to LDAP automatically with HTTP header.
  472. REM # In below example for siteminder, at right side of = is header name.
  473. REM SET HEADER_LOGIN_ID=HEADERUID
  474. REM SET HEADER_LOGIN_FIRSTNAME=HEADERFIRSTNAME
  475. REM SET HEADER_LOGIN_LASTNAME=HEADERLASTNAME
  476. REM SET HEADER_LOGIN_EMAIL=HEADEREMAILADDRESS
  477. REM ------------------------------------------------
  478. REM # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  479. REM # example : LOGOUT_WITH_TIMER=true
  480. REM SET LOGOUT_WITH_TIMER=
  481. REM # LOGOUT_IN : The number of days
  482. REM # example : LOGOUT_IN=1
  483. REM SET LOGOUT_IN=
  484. REM # LOGOUT_ON_HOURS : The number of hours
  485. REM # example : LOGOUT_ON_HOURS=9
  486. REM SET LOGOUT_ON_HOURS=
  487. REM # LOGOUT_ON_MINUTES : The number of minutes
  488. REM # example : LOGOUT_ON_MINUTES=55
  489. REM SET LOGOUT_ON_MINUTES=
  490. REM ## https://github.com/wekan/wekan/wiki/CAS
  491. REM SET CAS_ENABLED=true
  492. REM SET CAS_BASE_URL=https://cas.example.com/cas
  493. REM SET CAS_LOGIN_URL=https://cas.example.com/login
  494. REM SET CAS_VALIDATE_URL=https://cas.example.com/cas/p3/serviceValidate
  495. REM ## https://github.com/wekan/wekan/wiki/SAML
  496. REM SET SAML_ENABLED=true
  497. REM SET SAML_PROVIDER=
  498. REM SET SAML_ENTRYPOINT=
  499. REM SET SAML_ISSUER=
  500. REM SET SAML_CERT=
  501. REM SET SAML_IDPSLO_REDIRECTURL=
  502. REM SET SAML_PRIVATE_KEYFILE=
  503. REM SET SAML_PUBLIC_CERTFILE=
  504. REM SET SAML_IDENTIFIER_FORMAT=
  505. REM SET SAML_LOCAL_PROFILE_MATCH_ATTRIBUTE=
  506. REM SET SAML_ATTRIBUTES=
  507. REM # Wait spinner to use https://github.com/wekan/wekan/wiki/Wait-Spinners
  508. REM SET WAIT_SPINNER=Bounce
  509. REM # https://github.com/wekan/wekan/issues/3585#issuecomment-1021522132
  510. REM # Add more Node heap:
  511. REM # SET NODE_OPTIONS="--max_old_space_size=4096"
  512. REM # Add more stack. ulimit is not at Windows, stack-size is at Windows:
  513. REM # bash -c "ulimit -s 65500; exec node --stack-size=65500 main.js"
  514. REM #node --stack-size=65500 main.js
  515. REM #-------------------- OPTIONAL SETTINGS END --------------------
  516. node main.js