diff options
| author | Will Hunt <will@half-shot.uk> | 2022-12-01 13:46:24 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-01 13:46:24 +0000 |
| commit | 71f3e53ad010ba8c219f1076d40915b985760ed9 (patch) | |
| tree | f3ffe567b1cf39e9897e870970797f695de436a1 /docs/usage | |
| parent | Merge branch 'release-v1.73' into develop (diff) | |
| download | synapse-71f3e53ad010ba8c219f1076d40915b985760ed9.tar.xz | |
Add `push.enabled` option to disable push notification calculation (#14551)
* Add initial option * changelog * Some more linting
Diffstat (limited to 'docs/usage')
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 749af12aac..b9bde8f47e 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -3355,6 +3355,10 @@ Configuration settings related to push notifications This setting defines options for push notifications. 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 + 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 + not interested in push/unread counters. This is enabled by default. * `include_content`: Clients requesting push notifications can either have the body of the message sent in the notification poke along with other details like the sender, or just the event ID and room ID (`event_id_only`). @@ -3375,6 +3379,7 @@ This option has a number of sub-options. They are as follows: Example configuration: ```yaml push: + enable_push: true include_content: false group_unread_count_by_room: false ``` |