summary refs log tree commit diff
diff options
context:
space:
mode:
authorWill Hunt <will@half-shot.uk>2022-12-05 12:47:45 +0000
committerGitHub <noreply@github.com>2022-12-05 12:47:45 +0000
commite1779bc69fe217b2a8dac36beb9896f0c9dbfb3e (patch)
tree2691d42b06b1baa8b908055ddd0e6622d6d689b9
parentSuppress empty body warnings in room servelets (#14600) (diff)
downloadsynapse-e1779bc69fe217b2a8dac36beb9896f0c9dbfb3e.tar.xz
Fix push.enabled config documentation (#14619)
* Fix push.enabled config documentation

* Create 14619.doc

* Update 14619.doc
-rw-r--r--changelog.d/14619.doc1
-rw-r--r--docs/usage/configuration/config_documentation.md4
2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/14619.doc b/changelog.d/14619.doc
new file mode 100644
index 0000000000..f25e5494c0
--- /dev/null
+++ b/changelog.d/14619.doc
@@ -0,0 +1 @@
+Add new `push.enabled` config option to allow opting out of push notification calculation.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 0f47684f8c..dc5e5ac597 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3355,7 +3355,7 @@ 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
+* `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
    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.
@@ -3379,7 +3379,7 @@ This option has a number of sub-options. They are as follows:
 Example configuration:
 ```yaml
 push:
-  enable_push: true
+  enabled: true
   include_content: false
   group_unread_count_by_room: false
 ```