configuration

Documentation

Index

• type Configuration
  • func GetConfiguration() *Configuration
  • func (c *Configuration) GetAPI() configurationtypes.API
  • func (c *Configuration) GetCacheKeys() map[configurationtypes.RegValue]configurationtypes.Key
  • func (c *Configuration) GetDefaultCache() configurationtypes.DefaultCacheInterface
  • func (c *Configuration) GetLogLevel() string
  • func (c *Configuration) GetLogger() *zap.Logger
  • func (c *Configuration) GetReverseProxyURL() string
  • func (c *Configuration) GetSSLProviders() []string
  • func (c *Configuration) GetSurrogateKeys() map[string]configurationtypes.SurrogateKeys
  • func (c *Configuration) GetUrls() map[string]configurationtypes.URL
  • func (c *Configuration) GetYkeys() map[string]configurationtypes.SurrogateKeys
  • func (c *Configuration) Parse(data []byte) error
  • func (c *Configuration) SetLogger(l *zap.Logger)

Types

type Configuration

type Configuration struct {
	DefaultCache    *configurationtypes.DefaultCache                       `yaml:"default_cache"`
	CacheKeys       map[configurationtypes.RegValue]configurationtypes.Key `yaml:"cache_keys"`
	API             configurationtypes.API                                 `yaml:"api"`
	ReverseProxyURL string                                                 `yaml:"reverse_proxy_url"`
	SSLProviders    []string                                               `yaml:"ssl_providers"`
	URLs            map[string]configurationtypes.URL                      `yaml:"urls"`
	LogLevel        string                                                 `yaml:"log_level"`

	Ykeys         map[string]configurationtypes.SurrogateKeys `yaml:"ykeys"`
	SurrogateKeys map[string]configurationtypes.SurrogateKeys `yaml:"surrogate_keys"`
	// contains filtered or unexported fields
}

Configuration holder

func GetConfiguration

func GetConfiguration() *Configuration

GetConfiguration allow to retrieve Souin configuration through yaml file

func (*Configuration) GetAPI

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

GetAPI get the default cache

func (*Configuration) GetCacheKeys

func (c *Configuration) GetCacheKeys() map[configurationtypes.RegValue]configurationtypes.Key

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) GetLogger

func (c *Configuration) GetLogger() *zap.Logger

GetLogger get the logger

func (*Configuration) GetReverseProxyURL

func (c *Configuration) GetReverseProxyURL() string

GetReverseProxyURL get the reverse proxy url

func (*Configuration) GetSSLProviders

func (c *Configuration) GetSSLProviders() []string

GetSSLProviders get the ssl providers

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) Parse

func (c *Configuration) Parse(data []byte) error

Parse configuration

func (*Configuration) SetLogger

func (c *Configuration) SetLogger(l *zap.Logger)

SetLogger set the logger