{"id":16508611,"url":"https://github.com/osteele/matrix-archive","last_synced_at":"2025-03-21T08:31:17.963Z","repository":{"id":49457727,"uuid":"139216581","full_name":"osteele/matrix-archive","owner":"osteele","description":"Export a Matrix room message archive","archived":false,"fork":false,"pushed_at":"2021-06-17T05:54:56.000Z","size":44,"stargazers_count":40,"open_issues_count":3,"forks_count":12,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T22:56:14.272Z","etag":null,"topics":["dinacon","matrix-client"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osteele.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-30T03:39:19.000Z","updated_at":"2025-02-21T10:19:36.000Z","dependencies_parsed_at":"2022-07-30T15:48:59.400Z","dependency_job_id":null,"html_url":"https://github.com/osteele/matrix-archive","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fmatrix-archive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fmatrix-archive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fmatrix-archive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osteele%2Fmatrix-archive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osteele","download_url":"https://codeload.github.com/osteele/matrix-archive/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244122695,"owners_count":20401473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dinacon","matrix-client"],"created_at":"2024-10-11T15:46:33.698Z","updated_at":"2025-03-21T08:31:17.551Z","avatar_url":"https://github.com/osteele.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Matrix Archive Tools\n\nImport messages from a matrix.org room, for research, archival, and\npreservation.\n\nDeveloped at [Dinacon 2018](https://www.dinacon.org), for use by the\ndocumentation team.\n\nUse this responsibly and ethically. Don't re-publish people's messages\nwithout their knowledge and consent.\n\n## Setup\n\nInstall Pipenv. Run `pipenv install`.\n\nSet these environment variables: `MATRIX_USER`, `MATRIX_PASSWORD`,\n`MATRIX_ROOM_IDS` (and eventually `MATRIX_HOST` in case your homeserver\ndiffers from `https://matrix.org`).\n\n`MATRIX_ROOM_IDS` should be a comma-separated list of Matrix room IDs (or a\nsingle id). Run `pipenv run list` to list the room ids.\n\nSet `MONGODB_URI` to a MongoDB connection URL, *or* install a local MongoDB\ninstance.\n\n## Usage\n\n### Import Messages\n\n`pipenv run import` imports the messages into the database.\n\n### Export Messages\n\n`pipenv run export filename.html` exports a text, HTML, JSON, or YAML file,\ndepending on the name of `filename.html`. The file contains links to the image\ndownload URLs on the Matrix server.\n\n### Download Images\n\n`pipenv run download_images.py` downloads all the thumbnail images in the\ndatabase into a download directory (default `thumbnails`), skipping images that\nhave already been downloaded.\n\nUse the `--no-thumbnails` option to download full size images instead of\nthumbnails. In this case, the default directory is `images` instead of\n`thumbnails`.\n\n## References\n\n[Matrix Client-Server API](https://matrix.org/docs/spec/r0.0.0/client_server.html)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosteele%2Fmatrix-archive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosteele%2Fmatrix-archive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosteele%2Fmatrix-archive/lists"}