Notification Configuration Properties
Reference
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.
| Property | Default | What it does |
|---|---|---|
| notifications.enabled | true | Whether the notifications feature runs at all |
| notifications.emails.enabled | true | Whether the feature may send mail |
| notifications.emails.live.graceTime | 10 | Minutes to wait before sending a live mail, so that events arriving during that time travel together |
| notifications.watchedEntities.enabled | true | Whether users may watch locations and users |
| notifications.watchedEntities.autoWatch | major | What a user starts watching automatically: none, all, major or new |
| notifications.rest.poolSize | 2 | Threads serving the REST searches, which is what the unread counter uses; below 1 the pool is disabled |
| notifications.async.poolSize | 2 | Threads rendering the notifications menu |
| notifications.rest.cache | true | Whether search results are cached |
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.
Every property is commented out in the shipped file, so changing one means uncommenting it:
notifications.emails.live.graceTime = 5
notifications.watchedEntities.autoWatch = noneThe 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.
FAQ
When is turning the mail off the right answer?
When the instance struggles under the load of sending it; the rest of the feature keeps working, and the forum is the place to describe a scalability problem before disabling more than that.
Why are the thread pools so small?
So that searching for notifications cannot starve the rest of the instance. Raising them trades responsiveness elsewhere for a faster counter.
