Skip to content

Commit

Permalink
docs: S3 configuration added
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeWithEmad committed Sep 14, 2024
1 parent 1cbef60 commit 8cae871
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,24 @@ on LMS

![Preview H5P content in LMS](https://github.com/edly-io/h5pxblock/blob/master/docs/images/preview_content.png?raw=true)

### Configuring S3 as a Storage Backend

When utilizing AWS S3 to store content, it is essential to configure your settings appropriately. Specifically, you must define the `H5PXBLOCK_STORAGE` setting in your common configuration file, as S3 integration does not support private buckets.

Here is the required configuration:

```python
H5PXBLOCK_STORAGE = {
"storage_class": "storages.backends.s3boto3.S3Boto3Storage",
"settings": {
"bucket_name": "my-s3-public-bucket",
"querystring_auth": False,
"custom_domain": "my-s3-public-bucket.s3.eu-central-1.amazonaws.com"
},
}
```

Please ensure that your bucket is publicly accessible to enable seamless content storage and retrieval via S3.

# Working with translations

Expand Down

0 comments on commit 8cae871

Please sign in to comment.