maddy/docs/reference/blob/s3.md

Amazon S3

storage.blob.s3 module stores messages bodies in a bucket on S3-compatible storage.

storage.blob.s3 {
    endpoint play.min.io
    secure yes
    access_key "Q3AM3UQ867SPQQA43P2F"
    secret_key "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
    bucket maddy-test

    # optional
    region eu-central-1
    object_prefix maddy/
}

Example:

storage.imapsql local_mailboxes {
    ...
    msg_store s3 {
        endpoint s3.amazonaws.com
        access_key "..."
        secret_key "..."
        bucket maddy-messages
        region us-west-2
    }
}

Configuration directives

Syntax: endpoint _address:port_

REQUIRED.

Root S3 endpoint. e.g. s3.amazonaws.com

Syntax: secure boolean
Default: yes

Whether TLS should be used.

Syntax: access_key string
Syntax: secret_key _string_

REQUIRED.

Static S3 credentials.

Syntax: bucket _name_

REQUIRED.

S3 bucket name. The bucket must exist and be read-writable.

Syntax: region string
Default: not set

S3 bucket location. May be called "endpoint" in some manuals.

Syntax: object_prefix string
Default: empty string

String to add to all keys stored by maddy.

Can be useful when S3 is used as a file system.