plugin_simplecache_lvlsgroup

README

Simple Cache

This is a fork from https://github.com/traefik/plugin-simplecache

Simple cache plugin middleware caches responses on disk.

Configuration

To configure this plugin you should add its configuration to the Traefik dynamic configuration as explained here. The following snippet shows how to configure this plugin with the File provider in TOML and YAML:

Static:

[pilot]
  token="xxx"

[experimental.plugins.cache]
  modulename = "github.com/traefik/plugin-simplecache"
  version = "v0.2.1"

Dynamic:

[http.middlewares]
  [http.middlewares.my-cache.plugin.cache]
    path = "/some/path/to/cache/dir"

http:
  middlewares:
   my-cache:
      plugin:
        cache:
          path: /some/path/to/cache/dir

Options

Path (path)

The base path that files will be created under. This must be a valid existing filesystem path.

Max Expiry (maxExpiry)

Default: 300

The maximum number of seconds a response can be cached for. The actual cache time will always be lower or equal to this.

Cleanup (cleanup)

Default: 600

The number of seconds to wait between cache cleanup runs.

Add Status Header (addStatusHeader)

Default: true

This determines if the cache status header Cache-Status will be added to the response headers. This header can have the value hit, miss or error.

CacheQueryParams (cacheQueryParams)

Default: false

This determines if query parameters will also be part of the cached response.

BlacklistedHeaders (blacklistedHeaders)

Default: []

This sets a lists of headers that will make the cache skip caching the request and response.

Documentation

Overview

Package plugin_simplecache_lvlsgroup is a plugin to cache responses to disk.

Package plugin_simplecache_lvlsgroup is a plugin to cache responses to disk.

Index

• func New(_ context.Context, next http.Handler, cfg *Config, name string) (http.Handler, error)
• type Config
  • func CreateConfig() *Config

Functions

func New

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

New returns a plugin instance.

Types

type Config

type Config struct {
	Path               string   `json:"path" yaml:"path" toml:"path"`
	MaxExpiry          int      `json:"maxExpiry" yaml:"maxExpiry" toml:"maxExpiry"`
	Cleanup            int      `json:"cleanup" yaml:"cleanup" toml:"cleanup"`
	AddStatusHeader    bool     `json:"addStatusHeader" yaml:"addStatusHeader" toml:"addStatusHeader"`
	CacheQueryParams   bool     `json:"cacheQueryParams" yaml:"cacheQueryParams" toml:"cacheQueryParams"`
	BlacklistedHeaders []string `json:"blacklistedHeaders" yaml:"blacklistedHeaders" toml:"blacklistedHeaders"`
}

Config configures the middleware.

func CreateConfig

func CreateConfig() *Config

CreateConfig returns a config instance.