summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Hodgson <matthew@matrix.org>2017-11-04 19:34:59 +0000
committerMatthew Hodgson <matthew@matrix.org>2017-11-04 19:34:59 +0000
commit2ac6deafb7a2f00579092693e0392730a08a6b82 (patch)
tree4025b1a3c2500f463034392bd1d053c6e7e83477 /docs
parentMerge pull request #2630 from matrix-org/luke/fix-rooms-in-group (diff)
downloadsynapse-2ac6deafb7a2f00579092693e0392730a08a6b82.tar.xz
simplify instructions for regenerating user_dir
Diffstat (limited to 'docs')
-rw-r--r--docs/user_directory.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/user_directory.md b/docs/user_directory.md
new file mode 100644
index 0000000000..4c8ee44f37
--- /dev/null
+++ b/docs/user_directory.md
@@ -0,0 +1,17 @@
+User Directory API Implementation
+=================================
+
+The user directory is currently maintained based on the 'visible' users
+on this particular server - i.e. ones which your account shares a room with, or
+who are present in a publicly viewable room present on the server.
+
+The directory info is stored in various tables, which can (typically after
+DB corruption) get stale or out of sync.  If this happens, for now the
+quickest solution to fix it is:
+
+```
+UPDATE user_directory_stream_pos SET stream_id = NULL;
+```
+
+and restart the synapse, which should then start a background task to
+flush the current tables and regenerate the directory.