summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Hodgson <matthew@arasphere.net>2017-11-07 17:31:11 +0000
committerGitHub <noreply@github.com>2017-11-07 17:31:11 +0000
commit228ccf1fe388c7c489e8eaf03c01ec42537f423a (patch)
tree7f22d632f946b79ad68789946c2b669e8b889493 /docs
parentMerge pull request #2636 from farialima/me-master (diff)
parentcreate new indexes before dropping old ones to keep safetynet in place (diff)
downloadsynapse-228ccf1fe388c7c489e8eaf03c01ec42537f423a.tar.xz
Merge pull request #2643 from matrix-org/matthew/user_dir_typos
Fix various embarrassing typos around user_directory and add some doc.
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.