Mercurial > prosody-modules

annotate mod_storage_s3/README.md @ 5883:6c11e1b4066d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_admin_api: User activity gauges need to be summed (labels by host)
author Matthew Wild <mwild1@gmail.com>
date Tue, 16 Apr 2024 12:05:47 +0100
parents a5089978928a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5677
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 ```