Browse Source

Document the export user data command. (#14883)

ZAID BIN TARIQ 1 year ago
parent
commit
b15f0758e5
2 changed files with 9 additions and 0 deletions
  1. 1 0
      changelog.d/14883.doc
  2. 8 0
      docs/usage/administration/admin_faq.md

+ 1 - 0
changelog.d/14883.doc

@@ -0,0 +1 @@
+Document the export user data command. Contributed by @thezaidbintariq.

+ 8 - 0
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