From 0228983d52870279dcde60dadd5002447f372f40 Mon Sep 17 00:00:00 2001 From: kku Date: Mon, 10 Feb 2025 10:15:28 +0100 Subject: [PATCH] Updated README for caching --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 2c47899..f0e3165 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,27 @@ Mandatory keys to modify: After all of that you're good to go! Happy using :) +## Caching + +Although general database access speed is fast, caching might become helpful for +bigger servers with many bot interactions. Currently, Redis and Memcached are supported. + +Configuration happens through the config key `caching`. + +Set `caching.type` to the service of you choice ("redis" or "memcached") and then update +the URI to access the service. It's Redis' default URI format for Redis and "address:port" +for Memcached. + +Which one should I choose? + +| Service | Read/write speed | Config flexibility | +|-----------|------------------|--------------------| +| Redis | High | Very flexible | +| Memcached | Very high | Basic | + +> Performance difference between Redis and Memcached is generally quite low, so your setup +> should normally depend more on the configuration flexibility than on raw speed. + ## Docker [Experimental] As an experiment, Docker deployment option has been added. -- 2.39.5