File

mod_storage_s3/README.md @ 6195:886c985ece61

mod_lastlog2: Skip initializing internal API (and storage) in prosodyctl Initializing storage in the global context under prosodyctl causes the module.command to fail to execute because the storage module has already been loaded. Introduced in 7b722955c59b
author Kim Alvefur <zash@zash.se>
date Sat, 08 Feb 2025 14:12:18 +0100
parent 6140:476717ab3cd9
line wrap: on
line source

---
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.
:::

::: {.alert .alert-danger}
The data layout in S3 is not final and may change at any point in incompatible ways.
:::

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"
```