Wiki source code of Notification Configuration Properties
Last modified by Eleni Cojocariu on 2026/10/14 17:20
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | These properties are read from ##xwiki.properties## and take effect when the instance restarts. They are the settings that are not per user; everything a user can decide is in the administration instead, as described in [[Notifications>>doc:documentation.xs.admin.notifications.WebHome]]. | ||
| 2 | |||
| 3 | |=Property |=Default |=What it does | ||
| 4 | |##notifications.enabled##|##true##|Whether the notifications feature runs at all | ||
| 5 | |##notifications.emails.enabled##|##true##|Whether the feature may send mail | ||
| 6 | |##notifications.emails.live.graceTime##|##10##|Minutes to wait before sending a live mail, so that events arriving during that time travel together | ||
| 7 | |##notifications.watchedEntities.enabled##|##true##|Whether users may watch locations and users | ||
| 8 | |##notifications.watchedEntities.autoWatch##|##major##|What a user starts watching automatically: ##none##, ##all##, ##major## or ##new## | ||
| 9 | |##notifications.rest.poolSize##|##2##|Threads serving the REST searches, which is what the unread counter uses; below ##1## the pool is disabled | ||
| 10 | |##notifications.async.poolSize##|##2##|Threads rendering the notifications menu | ||
| 11 | |##notifications.rest.cache##|##true##|Whether search results are cached | ||
| 12 | |||
| 13 | The first two are the switches that turn off the whole feature, and its mail channel alone, for every user of the instance: see [[Enable or Disable Notifications>>doc:documentation.xs.admin.notifications.enable-disable-notifications.WebHome]]. | ||
| 14 | |||
| 15 | Every property is commented out in the shipped file, so changing one means uncommenting it: | ||
| 16 | |||
| 17 | {{code language="cfg"}} | ||
| 18 | notifications.emails.live.graceTime = 5 | ||
| 19 | notifications.watchedEntities.autoWatch = none | ||
| 20 | {{/code}} | ||
| 21 | |||
| 22 | The threads rendering the menu run below the priority of the rest of the instance, so a slow notification search does not slow the wiki down. The cached search results are kept for 24 hours, and a user's entry is dropped as soon as they change their own settings. |
