Skip to content

Commit

Permalink
📝 doc(cache) Specify that local cache is in memory and not in the fil…
Browse files Browse the repository at this point in the history
…esystem (#177)
  • Loading branch information
mathieuHa committed Jun 9, 2024
1 parent 123cf15 commit 36e6043
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ There are 5 operating modes (CrowdsecMode) for this plugin:

The `streaming mode` is recommended for performance, decisions are updated every 60 sec by default and that's the only communication between Traefik and Crowdsec. Every request that happens hits the cache for quick decisions.

The cache can be local to Traefik using the filesystem, or a separate Redis instance.
The cache can be local to Traefik in memory or using a separate Redis instance.

Below are Mermaid diagrams detailling how each mode work:

Expand Down Expand Up @@ -379,7 +379,7 @@ Only one instance of the plugin is *possible*.
- RedisCacheEnabled
- bool
- default: false
- enable Redis cache instead of filesystem cache
- enable Redis cache instead of in-memory cache
- RedisCacheHost
- string
- default: "redis:6379"
Expand Down
2 changes: 1 addition & 1 deletion bouncer.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Package crowdsec_bouncer_traefik_plugin implements a middleware that communicates with crowdsec.
// It can cache results to filesystem or redis, or even ask crowdsec for every requests.
// It can cache results in memory or using redis, or even ask crowdsec for every requests.
package crowdsec_bouncer_traefik_plugin //nolint:revive,stylecheck

import (
Expand Down

0 comments on commit 36e6043

Please sign in to comment.