cyberes
/
matrix-room-exporter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Cyberes 2024-04-04 00:21:05 -06:00
parent f2bf43ca84
commit eb010ae610
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -12,9 +12,9 @@ download.
3. [Create a Cloudflare R2 bucket](https://developers.cloudflare.com/r2/get-started/#2-create-a-bucket). 3. [Create a Cloudflare R2 bucket](https://developers.cloudflare.com/r2/get-started/#2-create-a-bucket).
4. Enable [public access](https://developers.cloudflare.com/r2/buckets/public-buckets/). 4. Enable [public access](https://developers.cloudflare.com/r2/buckets/public-buckets/).
5. Create an [access key](https://developers.cloudflare.com/r2/api/s3/tokens/). 5. Create an [access key](https://developers.cloudflare.com/r2/api/s3/tokens/).
6. Set up an [object lifecycle rule](https://developers.cloudflare.com/r2/buckets/object-lifecycles/) to auto-delete old 6. Configure `config.yml` with your R2 credentials.
7. Set up an [object lifecycle rule](https://developers.cloudflare.com/r2/buckets/object-lifecycles/) to auto-delete old
exports from your bucket. 24 hours is a good choice. 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](https://github.com/matrix-org/pantalaimon) for encrypted sync. 8. Set up a [matrix-org/pantalaimon](https://github.com/matrix-org/pantalaimon) for encrypted sync.
9. Create a new Matrix user and configure it in `config.yml`. 9. Create a new Matrix user and configure it in `config.yml`.
10. Start the bot with `python3 main.py` 10. Start the bot with `python3 main.py`
@ -27,4 +27,4 @@ download.
The bot will upload the exported room to your R2 bucket and share the link with the room. 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 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. able to export anything earlier than when it joined.able to export anything earlier than when it joined.