https://github.com/sagikazarmark/caddy-fs-s3
Caddy FS module for AWS S3
https://github.com/sagikazarmark/caddy-fs-s3
caddy caddy-fs caddy-module
Last synced: about 1 month ago
JSON representation
Caddy FS module for AWS S3
- Host: GitHub
- URL: https://github.com/sagikazarmark/caddy-fs-s3
- Owner: sagikazarmark
- License: mit
- Created: 2022-10-01T14:16:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T22:59:41.000Z (about 2 months ago)
- Last Synced: 2025-04-11T03:40:31.846Z (about 1 month ago)
- Topics: caddy, caddy-fs, caddy-module
- Language: Go
- Homepage: https://caddyserver.com/docs/modules/caddy.fs.s3
- Size: 521 KB
- Stars: 60
- Watchers: 3
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Caddy FS module for AWS S3
## Installation
Build Caddy using [xcaddy](https://github.com/caddyserver/xcaddy):
```shell
xcaddy build --with github.com/sagikazarmark/caddy-fs-s3
```
## Usage
```caddyfile
{
filesystem my-s3-fs s3 {
bucket mybucket
region us-east-1
# endpoint
# profile
# use_path_style
}
}
example.com {
file_server {
fs my-s3-fs
}
}
```
> [!NOTE]
> For a full parameter reference, check out the module [documentation page](https://caddyserver.com/docs/modules/caddy.fs.s3).
### Authentication
The module uses the AWS SDK [default credential chain](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html) to find valid credentials.
The easiest way to try the module is setting [static credentials](https://docs.aws.amazon.com/sdkref/latest/guide/feature-static-credentials.html) either in your AWS credentials file or as environment variables:
```shell
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
```
Caddy will pick up the credentials automatically.
## Development
Run Caddy with the following command:
```shell
task run
```
When all coding and testing is done, please run the test suite:
```shell
task check
```
For the best developer experience, install [Nix](https://builtwithnix.org/) and [direnv](https://direnv.net/).
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](LICENSE).