mirror_maker/synapse-s3-storage-provider

mirror of https://github.com/matrix-org/synapse-s3-storage-provider.git synced 2024-10-23 07:29:40 +00:00

Synapse storage provider to fetch and store media in Amazon S3

Find a file

Erik Johnston 197709f1f0 Merge pull request #16 from Sharparam/feature/improvements Generalize and improve threading		2019-05-22 14:32:50 +01:00
.gitignore	Fix a Py3 issue and package & test it better (#15 )	2018-10-23 20:48:22 +11:00
.travis.yml	Fix a Py3 issue and package & test it better (#15 )	2018-10-23 20:48:22 +11:00
LICENSE	Initial commit	2018-02-07 11:13:13 +00:00
MANIFEST.in	Fix a Py3 issue and package & test it better (#15 )	2018-10-23 20:48:22 +11:00
README.md	Update README	2019-03-14 22:56:23 +01:00
s3_storage_provider.py	Fix line too long	2019-03-14 22:54:41 +01:00
setup.cfg	Fix a Py3 issue and package & test it better (#15 )	2018-10-23 20:48:22 +11:00
setup.py	add boto3 as a dependency	2018-08-23 18:55:50 +01:00
test_s3.py	Fix test_s3.py to work with python 2	2019-03-14 23:10:00 +01:00
tox.ini	Fix a Py3 issue and package & test it better (#15 )	2018-10-23 20:48:22 +11:00

README.md

Synapse S3 Storage Provider

This module can be used by synapse as a storage provider, allowing it to fetch and store media in Amazon S3.

Usage

The s3_storage_provider.py should be on the PYTHONPATH when starting synapse.

Example of entry in synapse config:

media_storage_providers:
- module: s3_storage_provider.S3StorageProviderBackend
  store_local: True
  store_remote: True
  store_synchronous: True
  config:
    bucket: <S3_BUCKET_NAME>
    # All of the below options are optional, for use with non-AWS S3-like
    # services, or to specify access tokens here instead of some external method.
    region_name: <S3_REGION_NAME>
    endpoint_url: <S3_LIKE_SERVICE_ENDPOINT_URL>
    access_key_id: <S3_ACCESS_KEY_ID>
    secret_access_key: <S3_SECRET_ACCESS_KEY>

This module uses boto3, and so the credentials should be specified as described here.