traefik_s3_proxy_plugin

README

traefik-s3-proxy-plugin

This plugin is based on craigbrogle/traefik-s3-plugin code.

Changelog

s3-proxy 1.1.1

• Fixed AWS SigV4 object key escaping for reserved characters in paths ($, &, :, ;, =, @, +) to prevent SignatureDoesNotMatch with S3-compatible backends (including Yandex Object Storage).
• Fixed response header forwarding: Content-Length is now set only when the upstream S3 response contains a non-empty value.

s3-proxy 1.1.0

• Fixed incorrect handling of object keys containing /

s3-proxy 1.0.0

• The code has been improved
• Added the ability to select the endpoint type for a bucket: https://bucket.endpoit/prefix/key or https://endpoint/bucket/prefix/key

Usage (example for Yandex Cloud)

http:
  middlewares:
    s3-get:
      plugin:
        s3-proxy:
          Service: s3
          EndpointUrl: storage.yandexcloud.net
          Region: ru-central1
          AccessKeyID: xxxxxxxxxxxxxxxx
          SecretAccessKey: xxxxxxxxxxxxxxxx
          Bucket: some.bucket.name
          LinkStyle: path
  
  routers:
    gmc:
      entryPoints:
        - websecure
      rule: Host(`example.com`)
      service: noop@internal
      middlewares:
        - s3-get
      tls: {}

Documentation

Index

• func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config
• type S3Plugin
  • func (plugin S3Plugin) ServeHTTP(rw http.ResponseWriter, req *http.Request)
• type Service

Functions

func New

func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error)

Types

type Config

type Config struct {
	TimeoutSeconds int
	Service        string

	// Local directory
	Directory string

	// S3
	AccessKeyId     string
	SecretAccessKey string
	Region          string
	EndpointUrl     string
	Bucket          string
	Prefix          string
	LinkStyle       string
}

func CreateConfig

func CreateConfig() *Config

type S3Plugin

type S3Plugin struct {
	// contains filtered or unexported fields
}

func (S3Plugin) ServeHTTP

func (plugin S3Plugin) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type Service

type Service interface {
	Get(name string, rw http.ResponseWriter) ([]byte, error)
}