sagikazarmark / caddy-fs-s3

Caddy FS module for AWS S3
MIT License
50 stars 2 forks source link
caddy caddy-fs caddy-module

Caddy FS module for AWS S3

GitHub Workflow Status Caddy Version

Installation

Build Caddy using xcaddy:

xcaddy --with github.com/sagikazarmark/caddy-fs-s3

Usage

{
    filesystem my-s3-fs s3 {
        bucket mybucket
        region us-east-1

        # endpoint <endpoint>
        # profile <profile>
        # use_path_style
    }
}

example.com {
    file_server {
        fs my-s3-fs
    }
}

Development

Run Caddy with the following command:

task run

When all coding and testing is done, please run the test suite:

task check

For the best developer experience, install Nix and direnv.

Alternatively, install Go, xcaddy and the rest of the dependencies manually or using a package manager.

License

The project is licensed under the MIT License.