Mercurial > prosody-modules
comparison mod_storage_s3/README.md @ 5677:a5089978928a
mod_storage_s3: Add brief README
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 14 Oct 2023 23:05:59 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 5676:799f69a5921a | 5677:a5089978928a |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: Cloud Native Storage | |
| 5 ... | |
| 6 | |
| 7 ::: {.alert .alert-danger} | |
| 8 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 | |
| 9 is not yet complete. For now, this module is primarily suited for testing and finding areas where async work is incomplete. | |
| 10 ::: | |
| 11 | |
| 12 This module provides storage in Amazon S3 compatible things. It has been tested primarily with MinIO. | |
| 13 | |
| 14 ``` lua | |
| 15 s3_bucket = "prosody" | |
| 16 s3_base_uri = "http://localhost:9000" | |
| 17 s3_region = "us-east-1" | |
| 18 s3_access_key = "YOUR-ACCESS-KEY-HERE" | |
| 19 s3_secret_key = "YOUR-SECRET-KEY-HERE" | |
| 20 ``` |