From fbbd8ed6beb1c258e4030ad269b1099f3a02302c Mon Sep 17 00:00:00 2001 From: Michael Hollister Date: Wed, 1 May 2024 14:20:17 -0500 Subject: [PATCH] Added documentation for configuring new presence tracking options --- docs/usage/configuration/config_documentation.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 0c582d0387..2c1f46bca1 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -246,6 +246,8 @@ Example configuration: ```yaml presence: enabled: false + sync_presence_tracking: true + federation_presence_tracking: true ``` `enabled` can also be set to a special value of "untracked" which ignores updates @@ -254,6 +256,18 @@ received via clients and federation, while still accepting updates from the *The "untracked" option was added in Synapse 1.96.0.* +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 +require additional performance: +* `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 the sync endpoint is called. Note that client applications can still update their +presence by calling the respective presence endpoints. +* `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 +processing EDUs that do not contain updates to the `status_msg`, `displayname`, and +`avatar_url` fields. + --- ### `require_auth_for_profile_requests`