mirror_maker/synapse-s3-storage-provider
1
0
Fork 1
mirror of https://github.com/matrix-org/synapse-s3-storage-provider.git synced 2024-10-23 07:29:40 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add more documentation, correct line endings.

Browse source
This commit is contained in:
Michael Kaye 2019-06-05 10:01:09 +01:00
parent ad284721a0
commit 00d3697e63
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -35,23 +35,29 @@ described [here](https://boto3.readthedocs.io/en/latest/guide/configuration.html
Regular cleanup job Regular cleanup job
------------------- -------------------
There is additionally a `s3_media_upload.py` which can be used in a regular job to There is additionally a `s3_media_upload.py` which can be used in a regular job
upload content to s3, then delete that from local disk. This script can be used in to upload content to s3, then delete that from local disk. This script can be
combination with configuration for the storage provider to pull media from s3, but used in combination with configuration for the storage provider to pull media
upload it asynchronously. from s3, but upload it asynchronously.
Once the package is installed, the script should be run somewhat like the Once the package is installed, the script should be run somewhat like the
following. We suggest using tmux or screen as these can take a long time on larger following. We suggest using tmux or screen as these can take a long time on
servers. larger servers.
`database.yml` should contain the keys that would be passed to psycopg2 to
connect to your database. They can be found in the contents of the
`database`.`args` parameter in your homeserver.yaml.
More options are available in the command help. More options are available in the command help.
``` ```
> cd s3_media_upload > cd s3_media_upload
# cache.db will be created if absent. database.yaml is required to contain PG credentials # cache.db will be created if absent. database.yaml is required to
# contain PG credentials
> ls > ls
cache.db database.yaml cache.db database.yaml
# Update cache from /path/to/media/store looking for files not used within 2 months # Update cache from /path/to/media/store looking for files not used
# within 2 months
> s3_media_upload update /path/to/media/store 2m > s3_media_upload update /path/to/media/store 2m
Syncing files that haven't been accessed since: 2018-10-18 11:06:21.520602 Syncing files that haven't been accessed since: 2018-10-18 11:06:21.520602
Synced 0 new rows Synced 0 new rows