Document the export user data command. (#14883)

This commit is contained in:
ZAID BIN TARIQ 2023-01-25 17:01:27 +05:00 committed by GitHub
parent 4607be0b7b
commit b15f0758e5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 0 deletions

1
changelog.d/14883.doc Normal file
View file

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

View file

@ -32,6 +32,14 @@ What users are registered on my server?
SELECT NAME from users; 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 Manually resetting passwords
--- ---
Users can reset their password through their client. Alternatively, a server admin Users can reset their password through their client. Alternatively, a server admin