Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Document how to export user data #14530

Closed
aaronraimist opened this issue Nov 22, 2022 · 9 comments · Fixed by #14883
Closed

Document how to export user data #14530

aaronraimist opened this issue Nov 22, 2022 · 9 comments · Fixed by #14883
Labels
A-Docs things relating to the documentation good first issue Good for newcomers O-Occasional Affects or can be seen by some users regularly or most users rarely S-Minor Blocks non-critical functionality, workarounds exist. T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution

Comments

@aaronraimist
Copy link
Contributor

aaronraimist commented Nov 22, 2022

Description:

There is a command to export user data: python -m synapse.app.admin_cmd -c <config_file> export-data <user_id> but as far as I can tell it is not documented anywhere.

@DMRobertson DMRobertson added Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution A-Docs things relating to the documentation good first issue Good for newcomers S-Minor Blocks non-critical functionality, workarounds exist. T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. O-Occasional Affects or can be seen by some users regularly or most users rarely labels Nov 23, 2022
@aceArt-GmbH
Copy link
Contributor

The data will be exported to a folder under /tmp

But as far as I can tell, only room events are exported.
To be GDPR/DSGVO complaint, I think all data needs to be exported. Like the session info (user-agent, ip, ...).

But element already allows one to export their chat and see their session info 🤔

@aceArt-GmbH
Copy link
Contributor

Looking at what the this export provides, this does not seem to be GDPR or DSGVO compliant alone.
It exports only some room events, but not session information or similar

How do server administrators currently provide this data to the user?
Is there a custom script that one can use?
how does matrix.org i.e. do this?

@squahtx
Copy link
Contributor

squahtx commented Dec 14, 2022

There's no one-click script that will do a GDPR export yet. I hear the way matrix.org handles GDPR requests involves some amount of manual work.

@aaronraimist aaronraimist changed the title Document how to export user data (GDPR) Document how to export user data Dec 14, 2022
@aceArt-GmbH
Copy link
Contributor

https://github.com/philipaconrad/matrix-archiver-sqlite seems to be a potential option as it also exports devices and files

@ankit-pn
Copy link

Should we need to document it? If yes , then assign this issue to me, i will do it.

@dklimpel
Copy link
Contributor

Probably the easiest is if you make a pull request. Issues are rarely assigned directly.

@tjay27
Copy link
Contributor

tjay27 commented Jan 10, 2023

I'd like to document this, where should this be added?

@dklimpel
Copy link
Contributor

@thezaidbintariq
Copy link
Contributor

#14883

ShubhamSKadam added a commit to ShubhamSKadam/synapse that referenced this issue Jan 22, 2023
Documented a possible option for exporting data from the Synapse Matrix server.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Docs things relating to the documentation good first issue Good for newcomers O-Occasional Affects or can be seen by some users regularly or most users rarely S-Minor Blocks non-critical functionality, workarounds exist. T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution
Projects
None yet
8 participants