start-wekan.bat 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. REM ------------------------------------------------------------
  2. REM NOTE: THIS .BAT DOES NOT WORK !!
  3. REM Use instead this webpage instructions to build on Windows:
  4. REM https://github.com/wekan/wekan/wiki/Install-Wekan-from-source-on-Windows
  5. REM Please add fix PRs, like config of MongoDB etc.
  6. REM ------------------------------------------------------------
  7. REM # Debug OIDC OAuth2 etc.
  8. REM SET DEBUG=true
  9. REM ------------------------------------------------------------
  10. SET MONGO_URL=mongodb://127.0.0.1:27017/wekan
  11. SET ROOT_URL=http://127.0.0.1:2000/
  12. SET MAIL_URL=smtp://user:pass@mailserver.example.com:25/
  13. SET MAIL_FROM=admin@example.com
  14. SET PORT=2000
  15. REM # If you disable Wekan API with false, Export Board does not work.
  16. SET WITH_API=true
  17. REM # ==== RICH TEXT EDITOR IN CARD COMMENTS ====
  18. REM # https://github.com/wekan/wekan/pull/2560
  19. SET RICHER_CARD_COMMENT_EDITOR=true
  20. REM # ==== Allow to shrink attached/pasted image ====
  21. REM # https://github.com/wekan/wekan/pull/2544
  22. REM SET MAX_IMAGE_PIXEL=1024
  23. REM SET IMAGE_COMPRESS_RATIO=80
  24. REM # ==== PASSWORD BRUTE FORCE PROTECTION ====
  25. REM #https://atmospherejs.com/lucasantoniassi/accounts-lockout
  26. REM #Defaults below. Uncomment to change. wekan/server/accounts-lockout.js
  27. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURES_BEFORE=3
  28. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_PERIOD=60
  29. REM SET ACCOUNTS_LOCKOUT_KNOWN_USERS_FAILURE_WINDOW=15
  30. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURES_BERORE=3
  31. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_LOCKOUT_PERIOD=60
  32. REM SET ACCOUNTS_LOCKOUT_UNKNOWN_USERS_FAILURE_WINDOW=15
  33. REM # ==== BIGEVENTS DUE ETC NOTIFICATIONS =====
  34. REM # https://github.com/wekan/wekan/pull/2541
  35. REM # Introduced a system env var BIGEVENTS_PATTERN default as "due",
  36. REM # so any activityType matches the pattern, system will send out
  37. REM # notifications to all board members no matter they are watching
  38. REM # or tracking the board or not. Owner of the wekan server can
  39. REM # disable the feature by setting this variable to "NONE" or
  40. REM # change the pattern to any valid regex. i.e. '|' delimited
  41. REM # activityType names.
  42. REM # a) Default
  43. REM SET BIGEVENTS_PATTERN=due
  44. REM # b) All
  45. REM SET BIGEVENTS_PATTERN=received|start|due|end
  46. REM # c) Disabled
  47. REM SET BIGEVENTS_PATTERN=NONE
  48. REM # ==== EMAIL DUE DATE NOTIFICATION =====
  49. REM # https://github.com/wekan/wekan/pull/2536
  50. REM # System timelines will be showing any user modification for
  51. REM # dueat startat endat receivedat, also notification to
  52. REM # the watchers and if any card is due, about due or past due.
  53. REM # Notify due days, default 2 days before and after. 0 = due notifications disabled. Default: 2
  54. REM SET NOTIFY_DUE_DAYS_BEFORE_AND_AFTER=2
  55. REM # Notify due at hour of day. Default every morning at 8am. Can be 0-23.
  56. REM # If env variable has parsing error, use default. Notification sent to watchers.
  57. REM SET NOTIFY_DUE_AT_HOUR_OF_DAY=8
  58. REM # ==== EMAIL NOTIFICATION TIMEOUT, ms =====
  59. REM # Defaut: 30000 ms = 30s
  60. REM SET EMAIL_NOTIFICATION_TIMEOUT=30000
  61. REM # CORS: Set Access-Control-Allow-Origin header. Example: *
  62. REM SET CORS=*
  63. REM # To enable the Set Access-Control-Allow-Headers header. "Authorization,Content-Type" is required for cross-origin use of the API.
  64. REM SET CORS_ALLOW_HEADERS=Authorization,Content-Type
  65. REM # To enable the Set Access-Control-Expose-Headers header. This is not needed for typical CORS situations. Example: *
  66. REM SET CORS_EXPOSE_HEADERS=*
  67. REM # Optional: Integration with Matomo https://matomo.org that is installed to your server
  68. REM # The address of the server where Matomo is hosted.
  69. REM # example: - MATOMO_ADDRESS=https://example.com/matomo
  70. REM SET MATOMO_ADDRESS=
  71. REM # The value of the site ID given in Matomo server for Wekan
  72. REM # example: - MATOMO_SITE_ID=12345
  73. REM SET MATOMO_SITE_ID=
  74. REM # The option do not track which enables users to not be tracked by matomo
  75. REM # example: - MATOMO_DO_NOT_TRACK=false
  76. REM SET MATOMO_DO_NOT_TRACK=
  77. REM # The option that allows matomo to retrieve the username:
  78. REM # example: MATOMO_WITH_USERNAME=true
  79. REM SET MATOMO_WITH_USERNAME=false
  80. REM # Enable browser policy and allow one trusted URL that can have iframe that has Wekan embedded inside.
  81. REM # Setting this to false is not recommended, it also disables all other browser policy protections
  82. REM # and allows all iframing etc. See wekan/server/policy.js
  83. SET BROWSER_POLICY_ENABLED=true
  84. REM # When browser policy is enabled, HTML code at this Trusted URL can have iframe that embeds Wekan inside.
  85. REM SET TRUSTED_URL=
  86. 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 .
  87. REM # example: WEBHOOKS_ATTRIBUTES=cardId,listId,oldListId,boardId,comment,user,card,commentId
  88. REM SET WEBHOOKS_ATTRIBUTES=
  89. REM ------------------------------------------------------------
  90. REM # Enable the OAuth2 connection
  91. REM # OAuth2 docs: https://github.com/wekan/wekan/wiki/OAuth2
  92. REM # example: OAUTH2_ENABLED=true
  93. REM SET OAUTH2_ENABLED=false
  94. REM # OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345
  95. REM # example: OAUTH2_CLIENT_ID=abcde12345
  96. REM SET OAUTH2_CLIENT_ID=
  97. REM # OAuth2 Secret, for example from Rocket.Chat: Example: 54321abcde
  98. REM # example: OAUTH2_SECRET=54321abcde
  99. REM SET OAUTH2_SECRET=
  100. REM # OAuth2 Server URL, for example Rocket.Chat. Example: https://chat.example.com
  101. REM # example: OAUTH2_SERVER_URL=https://chat.example.com
  102. REM SET OAUTH2_SERVER_URL=
  103. REM # OAuth2 Authorization Endpoint. Example: /oauth/authorize
  104. REM # example: OAUTH2_AUTH_ENDPOINT=/oauth/authorize
  105. REM SET OAUTH2_AUTH_ENDPOINT=
  106. REM # OAuth2 Userinfo Endpoint. Example: /oauth/userinfo
  107. REM # example: OAUTH2_USERINFO_ENDPOINT=/oauth/userinfo
  108. REM SET OAUTH2_USERINFO_ENDPOINT=
  109. REM # OAuth2 Token Endpoint. Example: /oauth/token
  110. REM # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token
  111. REM SET OAUTH2_TOKEN_ENDPOINT=
  112. REM # OAUTH2 ID Token Whitelist Fields.
  113. REM SET OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[]
  114. REM # OAUTH2 Request Permissions.
  115. REM SET OAUTH2_REQUEST_PERMISSIONS='openid profile email'
  116. REM # OAuth2 ID Mapping
  117. REM SET OAUTH2_ID_MAP=
  118. REM # OAuth2 Username Mapping
  119. REM SET OAUTH2_USERNAME_MAP=
  120. REM # OAuth2 Fullname Mapping
  121. REM SET OAUTH2_FULLNAME_MAP=
  122. REM # OAuth2 Email Mapping
  123. REM SET OAUTH2_EMAIL_MAP=
  124. REM ------------------------------------------------------------
  125. REM # LDAP_ENABLE : Enable or not the connection by the LDAP
  126. REM # example : LDAP_ENABLE=true
  127. REM SET LDAP_ENABLE=false
  128. REM # LDAP_PORT : The port of the LDAP server
  129. REM # example : LDAP_PORT=389
  130. REM SET LDAP_PORT=389
  131. REM # LDAP_HOST : The host server for the LDAP server
  132. REM # example : LDAP_HOST=localhost
  133. REM SET LDAP_HOST=
  134. REM # LDAP_BASEDN : The base DN for the LDAP Tree
  135. REM # example : LDAP_BASEDN=ou=user,dc=example,dc=org
  136. REM SET LDAP_BASEDN=
  137. REM # LDAP_LOGIN_FALLBACK : Fallback on the default authentication method
  138. REM # example : LDAP_LOGIN_FALLBACK=true
  139. REM SET LDAP_LOGIN_FALLBACK=false
  140. REM # LDAP_RECONNECT : Reconnect to the server if the connection is lost
  141. REM # example : LDAP_RECONNECT=false
  142. REM SET LDAP_RECONNECT=true
  143. REM # LDAP_TIMEOUT : Overall timeout, in milliseconds
  144. REM # example : LDAP_TIMEOUT=12345
  145. REM SET LDAP_TIMEOUT=10000
  146. REM # LDAP_IDLE_TIMEOUT : Specifies the timeout for idle LDAP connections in milliseconds
  147. REM # example : LDAP_IDLE_TIMEOUT=12345
  148. REM SET LDAP_IDLE_TIMEOUT=10000
  149. REM # LDAP_CONNECT_TIMEOUT : Connection timeout, in milliseconds
  150. REM # example : LDAP_CONNECT_TIMEOUT=12345
  151. REM SET LDAP_CONNECT_TIMEOUT=10000
  152. REM # LDAP_AUTHENTIFICATION : If the LDAP needs a user account to search
  153. REM # example : LDAP_AUTHENTIFICATION=true
  154. REM SET LDAP_AUTHENTIFICATION=false
  155. REM # LDAP_AUTHENTIFICATION_USERDN : The search user DN
  156. REM # example: LDAP_AUTHENTIFICATION_USERDN=cn=admin,dc=example,dc=org
  157. REM SET LDAP_AUTHENTIFICATION_USERDN=
  158. REM # LDAP_AUTHENTIFICATION_PASSWORD : The password for the search user
  159. REM # example : AUTHENTIFICATION_PASSWORD=admin
  160. REM SET LDAP_AUTHENTIFICATION_PASSWORD=
  161. REM # LDAP_LOG_ENABLED : Enable logs for the module
  162. REM # example : LDAP_LOG_ENABLED=true
  163. REM SET LDAP_LOG_ENABLED=false
  164. REM # LDAP_BACKGROUND_SYNC : If the sync of the users should be done in the background
  165. REM # example : LDAP_BACKGROUND_SYNC=true
  166. REM SET LDAP_BACKGROUND_SYNC=false
  167. REM # LDAP_BACKGROUND_SYNC_INTERVAL : At which interval does the background task sync in milliseconds
  168. REM # At which interval does the background task sync in milliseconds.
  169. REM # Leave this unset, so it uses default, and does not crash.
  170. REM # https://github.com/wekan/wekan/issues/2354#issuecomment-515305722
  171. SET LDAP_BACKGROUND_SYNC_INTERVAL=''
  172. REM # LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED :
  173. REM # example : LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=true
  174. REM SET LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED=false
  175. REM # LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS :
  176. REM # example : LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=true
  177. REM SET LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS=false
  178. REM # LDAP_ENCRYPTION : If using LDAPS
  179. REM # example : LDAP_ENCRYPTION=ssl
  180. REM SET LDAP_ENCRYPTION=false
  181. REM # LDAP_CA_CERT : The certification for the LDAPS server. Certificate needs to be included in this docker-compose.yml file.
  182. REM # example : LDAP_CA_CERT=-----BEGIN CERTIFICATE-----MIIE+zCCA+OgAwIBAgIkAhwR/6TVLmdRY6hHxvUFWc0+Enmu/Hu6cj+G2FIdAgIC...-----END CERTIFICATE-----
  183. REM SET LDAP_CA_CERT=
  184. REM # LDAP_REJECT_UNAUTHORIZED : Reject Unauthorized Certificate
  185. REM # example : LDAP_REJECT_UNAUTHORIZED=true
  186. REM SET LDAP_REJECT_UNAUTHORIZED=false
  187. REM # Option to login to the LDAP server with the user's own username and password, instead of an administrator key. Default: false (use administrator key).
  188. REM SET LDAP_USER_AUTHENTICATION=true
  189. REM # Which field is used to find the user for the user authentication. Default: uid.
  190. REM SET LDAP_USER_AUTHENTICATION_FIELD=uid
  191. REM # LDAP_USER_SEARCH_FILTER : Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed
  192. REM # example : LDAP_USER_SEARCH_FILTER=
  193. REM SET LDAP_USER_SEARCH_FILTER=
  194. 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)
  195. REM # example : LDAP_USER_SEARCH_SCOPE=one
  196. REM SET LDAP_USER_SEARCH_SCOPE=
  197. REM # LDAP_USER_SEARCH_FIELD : Which field is used to find the user
  198. REM # example : LDAP_USER_SEARCH_FIELD=uid
  199. REM SET LDAP_USER_SEARCH_FIELD=
  200. REM # LDAP_SEARCH_PAGE_SIZE : Used for pagination (0=unlimited)
  201. REM # example : LDAP_SEARCH_PAGE_SIZE=12345
  202. REM SET LDAP_SEARCH_PAGE_SIZE=0
  203. REM # LDAP_SEARCH_SIZE_LIMIT : The limit number of entries (0=unlimited)
  204. REM #33 example : LDAP_SEARCH_SIZE_LIMIT=12345
  205. REM SET LDAP_SEARCH_SIZE_LIMIT=0
  206. REM # LDAP_GROUP_FILTER_ENABLE : Enable group filtering
  207. REM # example : LDAP_GROUP_FILTER_ENABLE=true
  208. REM SET LDAP_GROUP_FILTER_ENABLE=false
  209. REM # LDAP_GROUP_FILTER_OBJECTCLASS : The object class for filtering
  210. REM # example : LDAP_GROUP_FILTER_OBJECTCLASS=group
  211. REM SET LDAP_GROUP_FILTER_OBJECTCLASS=
  212. REM # LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE :
  213. REM # example :
  214. REM SET LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE=
  215. REM # LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE :
  216. REM # example :
  217. REM SET LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE=
  218. REM # LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT :
  219. REM # example :
  220. REM SET LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT=
  221. REM # LDAP_GROUP_FILTER_GROUP_NAME :
  222. REM # example :
  223. REM SET LDAP_GROUP_FILTER_GROUP_NAME=
  224. REM # LDAP_UNIQUE_IDENTIFIER_FIELD : This field is sometimes class GUID (Globally Unique Identifier)
  225. REM # example : LDAP_UNIQUE_IDENTIFIER_FIELD=guid
  226. REM SET LDAP_UNIQUE_IDENTIFIER_FIELD=
  227. REM # LDAP_UTF8_NAMES_SLUGIFY : Convert the username to utf8
  228. REM # example : LDAP_UTF8_NAMES_SLUGIFY=false
  229. REM SET LDAP_UTF8_NAMES_SLUGIFY=true
  230. REM # LDAP_USERNAME_FIELD : Which field contains the ldap username
  231. REM # example : LDAP_USERNAME_FIELD=username
  232. REM SET LDAP_USERNAME_FIELD=
  233. REM # LDAP_MERGE_EXISTING_USERS :
  234. REM # example : LDAP_MERGE_EXISTING_USERS=true
  235. REM SET LDAP_MERGE_EXISTING_USERS=false
  236. REM # LDAP_EMAIL_MATCH_ENABLE : allow existing account matching by e-mail address when username does not match
  237. REM # example: LDAP_EMAIL_MATCH_ENABLE=true
  238. REM SET LDAP_EMAIL_MATCH_ENABLE=false
  239. REM # LDAP_EMAIL_MATCH_REQUIRE : require existing account matching by e-mail address when username does match
  240. REM # example: LDAP_EMAIL_MATCH_REQUIRE=true
  241. REM SET LDAP_EMAIL_MATCH_REQUIRE=false
  242. REM # LDAP_EMAIL_MATCH_VERIFIED : require existing account email address to be verified for matching
  243. REM # example: LDAP_EMAIL_MATCH_VERIFIED=true
  244. REM SET LDAP_EMAIL_MATCH_VERIFIED=false
  245. REM # LDAP_EMAIL_FIELD : which field contains the LDAP e-mail address
  246. REM # example: LDAP_EMAIL_FIELD=mail
  247. REM SET LDAP_EMAIL_FIELD=
  248. REM # LDAP_SYNC_USER_DATA :
  249. REM # example : LDAP_SYNC_USER_DATA=true
  250. REM SET LDAP_SYNC_USER_DATA=false
  251. REM # LDAP_SYNC_USER_DATA_FIELDMAP :
  252. REM # example : LDAP_SYNC_USER_DATA_FIELDMAP={"cn":"name", "mail":"email"}
  253. REM SET LDAP_SYNC_USER_DATA_FIELDMAP=
  254. REM # LDAP_SYNC_GROUP_ROLES :
  255. REM # example :
  256. REM # SET LDAP_SYNC_GROUP_ROLES=
  257. REM # 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
  258. REM # example :
  259. REM SET LDAP_DEFAULT_DOMAIN=
  260. REM # Enable/Disable syncing of admin status based on ldap groups:
  261. REM SET LDAP_SYNC_ADMIN_STATUS=true
  262. REM # Comma separated list of admin group names to sync.
  263. REM SET LDAP_SYNC_ADMIN_GROUPS=group1,group2
  264. REM # Login to LDAP automatically with HTTP header.
  265. REM # In below example for siteminder, at right side of = is header name.
  266. REM SET HEADER_LOGIN_ID=HEADERUID
  267. REM SET HEADER_LOGIN_FIRSTNAME=HEADERFIRSTNAME
  268. REM SET HEADER_LOGIN_LASTNAME=HEADERLASTNAME
  269. REM SET HEADER_LOGIN_EMAIL=HEADEREMAILADDRESS
  270. REM ------------------------------------------------
  271. REM # LOGOUT_WITH_TIMER : Enables or not the option logout with timer
  272. REM # example : LOGOUT_WITH_TIMER=true
  273. REM SET LOGOUT_WITH_TIMER=
  274. REM # LOGOUT_IN : The number of days
  275. REM # example : LOGOUT_IN=1
  276. REM SET LOGOUT_IN=
  277. REM # LOGOUT_ON_HOURS : The number of hours
  278. REM # example : LOGOUT_ON_HOURS=9
  279. REM SET LOGOUT_ON_HOURS=
  280. REM # LOGOUT_ON_MINUTES : The number of minutes
  281. REM # example : LOGOUT_ON_MINUTES=55
  282. REM SET LOGOUT_ON_MINUTES=
  283. cd .build\bundle
  284. node main.js
  285. cd ..\..