matrix-org / synapse-s3-storage-provider

Synapse storage provider to fetch and store media in Amazon S3
Apache License 2.0
118 stars 33 forks source link

Improve documentation #108

Open zilchms opened 8 months ago

zilchms commented 8 months ago

This provider seems to lack some important documentation. After installing the provider and providing the correct config in the homeserver yaml, is there a need to build additional Infrastructure such as a systemd timer that calls the regular clean up job for new media files? Or is the provider doing this automatically for new media? There seems to be no good information at this time to be found and this would be a good place to add such documentation.

Edit: This ties a bit into https://github.com/matrix-org/synapse/issues/7140 which could either be linked or some basic directions given on what the provided example configuration here does.