cyberes
/
matrix-room-exporter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Export a Matrix a room.
8 Commits 1 Branch 0 Tags 65 KiB
Python 100%
Go to file
Cyberes 72dff170ca clean up on error 2024-04-03 23:28:27 -06:00
exporter clean up on error 2024-04-03 23:28:27 -06:00
.gitignore add files 2024-04-03 22:57:54 -06:00
LICENSE Initial commit 2024-04-03 19:41:36 -06:00
README.md logging and more info and service 2024-04-03 23:07:42 -06:00
config.yml.sample add files 2024-04-03 22:57:54 -06:00
main.py fix strings copied from other project 2024-04-03 23:16:30 -06:00
matrix-room-exporter.service logging and more info and service 2024-04-03 23:07:42 -06:00
requirements.txt add files 2024-04-03 22:57:54 -06:00

README.md

matrix-room-exporter

Export a Matrix a room.

A quick-n-dirty bot that exports a Matrix room and uploads the archive to a Cloudflare R2 bucket for the room to download.

Install

  1. pip install -r requirements.txt
  2. cp config.yml.sample config.yml
  3. Create a Cloudflare R2 bucket.
  4. Enable public access.
  5. Create an access key.
  6. Set up an object lifecycle rule to auto-delete old exports from your bucket. 24 hours is a good choice.
  7. Configure config.yml with your R2 credentials.
  8. Set up a matrix-org/pantalaimon for encrypted sync.
  9. Create a new Matrix user and configure it in config.yml.
  10. Start the bot with python3 main.py

Use

  1. Invite the new bot to the room you want to export.
  2. Send the message !export to start the export process.

The bot will upload the exported room to your R2 bucket and share the link with the room.

Remember, if your room is encrypted and new members can't see old history prior to their joining then the bot won't be able to export anything earlier than when it joined.