From 36e6043c328bd662fef0a414c68f0cfdeff04c5b Mon Sep 17 00:00:00 2001 From: mathieuHa Date: Sun, 9 Jun 2024 16:20:55 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20doc(cache)=20Specify=20that=20lo?= =?UTF-8?q?cal=20cache=20is=20in=20memory=20and=20not=20in=20the=20filesys?= =?UTF-8?q?tem=20(#177)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++-- bouncer.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9561643..75c913e 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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" diff --git a/bouncer.go b/bouncer.go index 3afa64f..8e06864 100644 --- a/bouncer.go +++ b/bouncer.go @@ -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 (