https://github.com/osteele/matrix-archive
Export a Matrix room message archive
https://github.com/osteele/matrix-archive
dinacon matrix-client
Last synced: 3 months ago
JSON representation
Export a Matrix room message archive
- Host: GitHub
- URL: https://github.com/osteele/matrix-archive
- Owner: osteele
- License: mit
- Created: 2018-06-30T03:39:19.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-17T05:54:56.000Z (about 4 years ago)
- Last Synced: 2025-03-15T22:56:14.272Z (3 months ago)
- Topics: dinacon, matrix-client
- Language: Python
- Size: 43 KB
- Stars: 40
- Watchers: 2
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Matrix Archive Tools
Import messages from a matrix.org room, for research, archival, and
preservation.
Developed at [Dinacon 2018](https://www.dinacon.org), for use by the
documentation team.
Use this responsibly and ethically. Don't re-publish people's messages
without their knowledge and consent.
## Setup
Install Pipenv. Run `pipenv install`.
Set these environment variables: `MATRIX_USER`, `MATRIX_PASSWORD`,
`MATRIX_ROOM_IDS` (and eventually `MATRIX_HOST` in case your homeserver
differs from `https://matrix.org`).
`MATRIX_ROOM_IDS` should be a comma-separated list of Matrix room IDs (or a
single id). Run `pipenv run list` to list the room ids.
Set `MONGODB_URI` to a MongoDB connection URL, *or* install a local MongoDB
instance.
## Usage
### Import Messages
`pipenv run import` imports the messages into the database.
### Export Messages
`pipenv run export filename.html` exports a text, HTML, JSON, or YAML file,
depending on the name of `filename.html`. The file contains links to the image
download URLs on the Matrix server.
### Download Images
`pipenv run download_images.py` downloads all the thumbnail images in the
database into a download directory (default `thumbnails`), skipping images that
have already been downloaded.
Use the `--no-thumbnails` option to download full size images instead of
thumbnails. In this case, the default directory is `images` instead of
`thumbnails`.
## References
[Matrix Client-Server API](https://matrix.org/docs/spec/r0.0.0/client_server.html)
## License
MIT