summary refs log tree commit diff
diff options
context:
space:
mode:
authorZAID BIN TARIQ <57444558+thezaidbintariq@users.noreply.github.com>2023-01-25 17:01:27 +0500
committerGitHub <noreply@github.com>2023-01-25 07:01:27 -0500
commitb15f0758e59c8705ff50a414a5683286b5972381 (patch)
treec1052d5b425f10e094369c98de66679beef4de17
parentRequest partial joins by default (#14905) (diff)
downloadsynapse-b15f0758e59c8705ff50a414a5683286b5972381.tar.xz
Document the export user data command. (#14883)
-rw-r--r--changelog.d/14883.doc1
-rw-r--r--docs/usage/administration/admin_faq.md8
2 files changed, 9 insertions, 0 deletions
diff --git a/changelog.d/14883.doc b/changelog.d/14883.doc
new file mode 100644
index 0000000000..8e36cb1c3b
--- /dev/null
+++ b/changelog.d/14883.doc
@@ -0,0 +1 @@
+Document the export user data command. Contributed by @thezaidbintariq.
\ No newline at end of file
diff --git a/docs/usage/administration/admin_faq.md b/docs/usage/administration/admin_faq.md
index a6dc6197c9..18ce6171db 100644
--- a/docs/usage/administration/admin_faq.md
+++ b/docs/usage/administration/admin_faq.md
@@ -32,6 +32,14 @@ What users are registered on my server?
 SELECT NAME from users;
 ```
 
+How can I export user data?
+---
+Synapse includes a Python command to export data for a specific user. It takes the homeserver
+configuration file and the full Matrix ID of the user to export:
+```console
+python -m synapse.app.admin_cmd -c <config_file> export-data <user_id>
+```
+
 Manually resetting passwords
 ---
 Users can reset their password through their client. Alternatively, a server admin