summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMichael Hollister <michael.s.hollister@protonmail.com>2024-07-23 04:59:24 -0500
committerGitHub <noreply@github.com>2024-07-23 09:59:24 +0000
commita9ee832e4899fefcfd27fba475091e1ffaa069b8 (patch)
tree5e5922d2aaf6c388150a978905bc001653b954ab /docs
parentBump hiredis from 2.3.2 to 3.0.0 (#17464) (diff)
downloadsynapse-a9ee832e4899fefcfd27fba475091e1ffaa069b8.tar.xz
Fixed presence results not returning offline users on initial sync (#17231)
This is to address an issue in which `m.presence` results on initial
sync are not returning entries of users who are currently offline.

The original behaviour was from
https://github.com/element-hq/synapse/issues/1535

This change is useful for applications that use the
presence system for tracking user profile information/updates (e.g.
https://github.com/element-hq/synapse/pull/16992 or for profile status
messages).

This is gated behind a new configuration option to avoid performance
impact for applications that don't need this, as a pragmatic solution
for now.
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index e8bc2df798..649f4f71c7 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -246,6 +246,7 @@ Example configuration:
 ```yaml
 presence:
   enabled: false
+  include_offline_users_on_sync: false
 ```
 
 `enabled` can also be set to a special value of "untracked" which ignores updates
@@ -254,6 +255,10 @@ received via clients and federation, while still accepting updates from the
 
 *The "untracked" option was added in Synapse 1.96.0.*
 
+When clients perform an initial or `full_state` sync, presence results for offline users are
+not included by default. Setting `include_offline_users_on_sync` to `true` will always include
+offline users in the results. Defaults to false.
+
 ---
 ### `require_auth_for_profile_requests`