https://github.com/traefik/plugin-simplecache
Simple cache plugin middleware caches responses on disk
https://github.com/traefik/plugin-simplecache
traefik traefik-plugin
Last synced: 8 months ago
JSON representation
Simple cache plugin middleware caches responses on disk
- Host: GitHub
- URL: https://github.com/traefik/plugin-simplecache
- Owner: traefik
- License: apache-2.0
- Created: 2020-07-07T14:39:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-05T08:38:02.000Z (over 3 years ago)
- Last Synced: 2024-06-19T00:33:16.617Z (about 2 years ago)
- Topics: traefik, traefik-plugin
- Language: Go
- Homepage: https://plugins.traefik.io/plugins/628c9ec2ffc0cd18356a97a2/log4-shell
- Size: 37.1 KB
- Stars: 43
- Watchers: 15
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://docs.traefik.io/getting-started/configuration-overview/#the-dynamic-configuration).
The following snippet shows how to configure this plugin with the File provider in TOML and YAML:
Static:
```toml
[experimental.plugins.cache]
modulename = "github.com/traefik/plugin-simplecache"
version = "v0.2.1"
```
Dynamic:
```toml
[http.middlewares]
[http.middlewares.my-cache.plugin.cache]
path = "/some/path/to/cache/dir"
```
```yaml
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`.