README.md

Caddy FS module for AWS S3

Installation

Build Caddy using xcaddy:

xcaddy build --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
    }
}

Note

For a full parameter reference, check out the module documentation page.

Authentication

The module uses the AWS SDK default credential chain to find valid credentials.

The easiest way to try the module is setting static credentials either in your AWS credentials file or as environment variables:

export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...

Caddy will pick up the credentials automatically.

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.