Improved wording of presence tracking documentation

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
This commit is contained in:
Michael Hollister 2024-05-30 15:24:30 -05:00 committed by GitHub
parent 8386b98e11
commit 89d8b32af7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -257,15 +257,15 @@ received via clients and federation, while still accepting updates from the
*The "untracked" option was added in Synapse 1.96.0.* *The "untracked" option was added in Synapse 1.96.0.*
Enabling presence tracking can be resource intensive for the presence handler when server-side Enabling presence tracking can be resource intensive for the presence handler when server-side
tracking of user activity is enabled. Below are some additional configuration options if you tracking of user activity is enabled. Below are some additional configuration options which may
require additional performance: help improve the performance of the presence feature without outright disabling it:
* `sync_presence_tracking` (Default enabled): Determines if the server tracks a user's presence * `sync_presence_tracking` (Default enabled): Determines if the server tracks a user's presence
activity when syncing. If disabled, the server will not automatically update the user's presence activity when syncing. If disabled, the server will not automatically update the user's presence
activity when the sync endpoint is called. Note that client applications can still update their activity when the sync endpoint is called. Note that client applications can still update their
presence by calling the respective presence endpoints. presence by calling the respective presence endpoints.
* `federation_presence_tracking` (Default enabled): Determines if the server will accept * `federation_presence_tracking` (Default enabled): Determines if the server will accept
presence EDUs that only contain presence activity updates. If disabled, the server will drop presence EDUs that only contain presence activity updates. If disabled, the server will drop
processing EDUs that do not contain updates to the `status_msg`, `displayname`, and processing EDUs that do not contain updates to the `status_msg`, `displayname`, or
`avatar_url` fields. `avatar_url` fields.
--- ---