mod_storage_s3/README.md
author aidan@jmad.org
Thu, 15 Feb 2024 09:20:50 -0800
changeset 5843 fba64b043c52
parent 5681 a5089978928a
permissions -rw-r--r--
mod_http_upload_external: Fix typo in access documentation.

---
labels:
- 'Stage-Alpha'
summary: Cloud Native Storage
...

::: {.alert .alert-danger}
This storage driver is fully async and requires that all storage access happens in an async-compatible context. As of 2023-10-14 this work in Prosody
is not yet complete. For now, this module is primarily suited for testing and finding areas where async work is incomplete.
:::

This module provides storage in Amazon S3 compatible things. It has been tested primarily with MinIO.

``` lua
s3_bucket = "prosody"
s3_base_uri = "http://localhost:9000"
s3_region = "us-east-1"
s3_access_key = "YOUR-ACCESS-KEY-HERE"
s3_secret_key = "YOUR-SECRET-KEY-HERE"
```