Merge pull request 'Updated README for caching' (#25) from feature/cache into dev

Reviewed-on: #25
This commit is contained in:
Profitroll 2025-02-10 11:17:47 +02:00
commit a4967e5b77

View File

@ -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.