summary refs log tree commit diff
path: root/docs/upgrade.md
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2023-04-04 13:08:17 +0100
committerGitHub <noreply@github.com>2023-04-04 12:08:17 +0000
commitc0772b4461ff396b6a09b4a17368d61a2810c452 (patch)
treea4d0e89e6cea2d9ae7e18239d991753eff8a9a39 /docs/upgrade.md
parentBuild Debian packages for Ubuntu 23.04 Lunar Lobster (#15381) (diff)
downloadsynapse-c0772b4461ff396b6a09b4a17368d61a2810c452.tar.xz
Note that Synapse 1.74 queued a user dir rebuild (#15386)
* Note that Synapse 1.74 queued a user dir rebuild

* Changelog
Diffstat (limited to '')
-rw-r--r--docs/upgrade.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md
index 1ddfc31ff6..0886b03115 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -199,6 +199,17 @@ Docker images and Debian packages need nothing specific as they already
 include or specify ICU as an explicit dependency.
 
 
+## User directory rebuild
+
+Synapse 1.74 queues a background update
+[to rebuild the user directory](https://github.com/matrix-org/synapse/pull/14643),
+in order to fix missing or erroneous entries.
+
+When this update begins, the user directory will be cleared out and rebuilt from
+scratch. User directory lookups will be incomplete until the rebuild completes.
+Admins can monitor the rebuild's progress by using the
+[Background update Admin API](usage/administration/admin_api/background_updates.md#status).
+
 # Upgrading to v1.73.0
 
 ## Legacy Prometheus metric names have now been removed