/Simple Cache

Simple Cache

44
v0.2.1

Simple Cache

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.