traefik

package module

v1.7.9 Latest Latest Go to latest Published: Sep 16, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/darkweak/souin

Links

Open Source Insights

Documentation ¶

Index ¶

func New(_ context.Context, next http.Handler, config *TestConfiguration, name string) (http.Handler, error)
type Configuration
type SouinTraefikMiddleware
- func (s *SouinTraefikMiddleware) ServeHTTP(rw http.ResponseWriter, req *http.Request)
type TestConfiguration
- func CreateConfig() *TestConfiguration

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

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

New create Souin instance.

Types ¶

type Configuration ¶

type Configuration struct {
	DefaultCache         *configurationtypes.DefaultCache            `json:"default_cache" yaml:"default_cache"`
	API                  configurationtypes.API                      `json:"api" yaml:"api"`
	CacheKeys            configurationtypes.CacheKeys                `yaml:"cache_keys"`
	URLs                 map[string]configurationtypes.URL           `json:"urls" yaml:"urls"`
	LogLevel             string                                      `json:"log_level" yaml:"log_level"`
	Ykeys                map[string]configurationtypes.SurrogateKeys `json:"ykeys" yaml:"ykeys"`
	SurrogateKeys        map[string]configurationtypes.SurrogateKeys `json:"surrogate_keys" yaml:"surrogate_keys"`
	SurrogateKeyDisabled bool                                        `json:"disable_surrogate_key" yaml:"disable_surrogate_key"`
}

Configuration holder

func (*Configuration) GetAPI ¶

func (c *Configuration) GetAPI() configurationtypes.API

GetAPI get the default cache

func (*Configuration) GetCacheKeys ¶

func (c *Configuration) GetCacheKeys() configurationtypes.CacheKeys

GetCacheKeys get the cache keys rules to override

func (*Configuration) GetDefaultCache ¶

func (c *Configuration) GetDefaultCache() configurationtypes.DefaultCacheInterface

GetDefaultCache get the default cache

func (*Configuration) GetLogLevel ¶

func (c *Configuration) GetLogLevel() string

GetLogLevel get the log level

func (*Configuration) GetPluginName ¶

func (c *Configuration) GetPluginName() string

GetPluginName get the plugin name

func (*Configuration) GetSurrogateKeys ¶

func (c *Configuration) GetSurrogateKeys() map[string]configurationtypes.SurrogateKeys

GetSurrogateKeys get the surrogate keys list

func (*Configuration) GetUrls ¶

func (c *Configuration) GetUrls() map[string]configurationtypes.URL

GetUrls get the urls list in the configuration

func (*Configuration) GetYkeys ¶

func (c *Configuration) GetYkeys() map[string]configurationtypes.SurrogateKeys

GetYkeys get the ykeys list

func (*Configuration) IsSurrogateDisabled ¶ added in v1.7.7

func (c *Configuration) IsSurrogateDisabled() bool

IsSurrogateDisabled disable the surrogate storage

type SouinTraefikMiddleware ¶

type SouinTraefikMiddleware struct {
	*middleware.SouinBaseHandler
	// contains filtered or unexported fields
}

SouinTraefikMiddleware declaration.

func (*SouinTraefikMiddleware) ServeHTTP ¶

func (s *SouinTraefikMiddleware) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type TestConfiguration ¶

type TestConfiguration map[string]interface{}

TestConfiguration is the temporary configuration for Træfik

func CreateConfig ¶

func CreateConfig() *TestConfiguration

CreateConfig creates the default plugin configuration.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
override
api
api/prometheus
configurationtypes
context
middleware
rfc
storage
storage/types
surrogate/providers

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL