Fix push.enabled config documentation (#14619)

* Fix push.enabled config documentation

* Create 14619.doc

* Update 14619.doc
This commit is contained in:
Will Hunt 2022-12-05 12:47:45 +00:00 committed by GitHub
parent 93ac3c197e
commit e1779bc69f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions

1
changelog.d/14619.doc Normal file
View file

@ -0,0 +1 @@
Add new `push.enabled` config option to allow opting out of push notification calculation.

View file

@ -3355,7 +3355,7 @@ Configuration settings related to push notifications
This setting defines options for push notifications. This setting defines options for push notifications.
This option has a number of sub-options. They are as follows: This option has a number of sub-options. They are as follows:
* `enable_push`: Enables or disables push notification calculation. Note, disabling this will also * `enabled`: Enables or disables push notification calculation. Note, disabling this will also
stop unread counts being calculated for rooms. This mode of operation is intended stop unread counts being calculated for rooms. This mode of operation is intended
for homeservers which may only have bots or appservice users connected, or are otherwise for homeservers which may only have bots or appservice users connected, or are otherwise
not interested in push/unread counters. This is enabled by default. not interested in push/unread counters. This is enabled by default.
@ -3379,7 +3379,7 @@ This option has a number of sub-options. They are as follows:
Example configuration: Example configuration:
```yaml ```yaml
push: push:
enable_push: true enabled: true
include_content: false include_content: false
group_unread_count_by_room: false group_unread_count_by_room: false
``` ```