plugin

package module

v0.0.0-...-bd39ce9 Latest Latest Go to latest Published: Feb 19, 2026 License: MIT Imports: 11 Imported by: 0

Details

Provide a read-only S3 backend for Caddy to serve static files from a private S3 bucket.

Serving static files through caddy from a private S3 bucket may have different use-cases.
There is another project lindenlab/caddy-s3 which has sadly not been maintained for a long time and causes memory-leaks in production.
The file system backed plugins lack control over utilising custom s3 metadata like caching or content-types.

Use mise-en-place or install the required tools mentioned in the mise configuration.
Have docker compose up and running to spin up the test dependencies.

This section is empty.

This section is empty.

This section is empty.

type Configuration struct {
	AwsEndpoint  string
	Bucket       string
	UsePathStyle bool
}

func Parse(d *caddyfile.Dispenser) (*Configuration, error)

type S3Proxy struct {
	Config *Configuration `json:"config,omitempty"`
}

func (*S3Proxy) CaddyModule() caddy.ModuleInfo

func (m *S3Proxy) Provision(ctx caddy.Context) error

func (m *S3Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

func (m *S3Proxy) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

func (m *S3Proxy) Validate() error