start-wekan.sh 27 KB

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