2018-02-13 13:55:17 +00:00
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
media_storage_providers:
|
|
|
|
|
- module: s3_storage_provider.S3StorageProviderBackend
|
|
|
|
|
store_local: True
|
|
|
|
|
store_remote: True
|
|
|
|
|
store_synchronous: True
|
|
|
|
|
config:
|
|
|
|
|
bucket: <S3_BUCKET_NAME>
|
2019-03-14 21:56:23 +00:00
|
|
|
# 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>
|
2018-02-13 13:55:17 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This module uses `boto3`, and so the credentials should be specified as
|
|
|
|
|
described [here](https://boto3.readthedocs.io/en/latest/guide/configuration.html#guide-configuration).
|
|
|
|
|
|
