diff options
author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2020-11-25 21:02:53 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-25 21:02:53 +0000 |
commit | 2b110dda2a66f8bcd69b68411ebab94c9e2593c2 (patch) | |
tree | 98f4708d4d28eb92767a4a785d74d3a2caa0ba07 /docs | |
parent | Speed up remote invite rejection database call (#8815) (diff) | |
download | synapse-2b110dda2a66f8bcd69b68411ebab94c9e2593c2.tar.xz |
Fix the formatting of push config section (#8818)
This PR updates the push config's formatting to better align with our [code style guidelines](https://github.com/matrix-org/synapse/blob/develop/docs/code_style.md#configuration-file-format).
Diffstat (limited to '')
-rw-r--r-- | docs/sample_config.yaml | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 52a1d8b853..df0f3e1d8e 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -2251,20 +2251,25 @@ password_providers: -# 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`). -# If clients choose the former, this option controls whether the -# notification request includes the content of the event (other details -# like the sender are still included). For `event_id_only` push, it -# has no effect. -# -# For modern android devices the notification content will still appear -# because it is loaded by the app. iPhone, however will send a -# notification saying only that a message arrived and who it came from. -# -#push: -# include_content: true +## Push ## + +push: + # 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`). + # If clients choose the former, this option controls whether the + # notification request includes the content of the event (other details + # like the sender are still included). For `event_id_only` push, it + # has no effect. + # + # For modern android devices the notification content will still appear + # because it is loaded by the app. iPhone, however will send a + # notification saying only that a message arrived and who it came from. + # + # The default value is "true" to include message details. Uncomment to only + # include the event ID and room ID in push notification payloads. + # + #include_content: false # Spam checkers are third-party modules that can block specific actions |