prosody-modules
d0a117e11cb8
mod_storage_s3/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_storage_s3/README.md @ 6183:d0a117e11cb8

mod_groups_internal: Improve Markdown structure of documentation
author Rémi Bardon <remi@remibardon.name>
date Fri, 31 Jan 2025 02:16:55 +0100
parent 6140:476717ab3cd9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5700
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
6140
476717ab3cd9 mod_storage_s3: Note about data format change
Kim Alvefur <zash@zash.se>
parents: 5700
diff changeset
12 ::: {.alert .alert-danger}
476717ab3cd9 mod_storage_s3: Note about data format change
Kim Alvefur <zash@zash.se>
parents: 5700
diff changeset
13 The data layout in S3 is not final and may change at any point in incompatible ways.
476717ab3cd9 mod_storage_s3: Note about data format change
Kim Alvefur <zash@zash.se>
parents: 5700
diff changeset
14 :::
476717ab3cd9 mod_storage_s3: Note about data format change
Kim Alvefur <zash@zash.se>
parents: 5700
diff changeset
15
5700
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 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
17
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 ``` lua
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 s3_bucket = "prosody"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 s3_base_uri = "http://localhost:9000"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 s3_region = "us-east-1"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 s3_access_key = "YOUR-ACCESS-KEY-HERE"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 s3_secret_key = "YOUR-SECRET-KEY-HERE"
a5089978928a mod_storage_s3: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 ```