mod_storage_s3/README.md
author Kim Alvefur <zash@zash.se>
Sun, 03 Mar 2024 11:23:40 +0100
changeset 5857 97c9b76867ca
parent 5681 a5089978928a
permissions -rw-r--r--
mod_log_ringbuffer: Detach event handlers on logging reload (thanks Menel) Otherwise the global event handlers accumulate, one added each time logging is reoladed, and each invocation of the signal or event triggers one dump of each created ringbuffer.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5681
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
---
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
labels:
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
- 'Stage-Alpha'
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
summary: Cloud Native Storage
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
...
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
::: {.alert .alert-danger}
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     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
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
is not yet complete. For now, this module is primarily suited for testing and finding areas where async work is incomplete.
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
:::
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
This module provides storage in Amazon S3 compatible things. It has been tested primarily with MinIO.
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
``` lua
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
s3_bucket = "prosody"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
s3_base_uri = "http://localhost:9000"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
s3_region = "us-east-1"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
s3_access_key = "YOUR-ACCESS-KEY-HERE"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
s3_secret_key = "YOUR-SECRET-KEY-HERE"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
```