How-to guides#
These guides solve one task each, for a project that already runs Plone.
📦 Install the package
Add the dependency, and load the ZCML with or without autoinclude.
⚙️ Configure Redis
Point Plone at Redis, and run Redis as a private, bounded cache.
🔁 Use Valkey
Swap Redis for Valkey without changing the URL scheme.
🎯 Include and exclude functions
Choose which cached functions may use Redis.
⏱️ Give a function its own TTL
Cache a function of your add-on for a lifetime of its own.
🧹 Invalidate after a deploy
Drop values that new code computes differently.
📊 Monitor the cache
Read the status endpoint, the counters, and the logs.
🧪 Test your add-on
Run your add-on's tests against a fake Redis.
🩺 Troubleshoot
Find the cause of the most common problems.