Feature overview

• A pure php redis connector
• High availability support
• Exposes redis cache object for use for use by other add-ons
• Implements some minor caching of forum thread counts
• Redirect's XenForo's individual css template caching to hit redis as otherwise it causes unexpected write & deadlocking on the xf_css_cache table

Installation
Edit src/config.php and add:

<span>$config</span><span>[</span><span>'cache'</span><span>]</span><span>[</span><span>'enabled'</span><span>]</span> <span>=</span> <span>true</span><span>;</span><br><span>$config</span><span>[</span><span>'cache'</span><span>]</span><span>[</span><span>'sessions'</span><span>]</span> <span>=</span> <span>true</span><span>;</span><br><span>$config</span><span>[</span><span>'cache'</span><span>]</span><span>[</span><span>'provider'</span><span>]</span> <span>=</span> <span>'SV\RedisCache\Redis'</span><span>;</span><br><span>$config</span><span>[</span><span>'cache'</span><span>]</span><span>[</span><span>'config'</span><span>]</span> <span>=</span> <span>[</span><br> <span>'server'</span> <span>=</span><span>&gt;</span> <span>'127.0.0.1'</span><span>,</span><br> <span>'port'</span> <span>=</span><span>&gt;</span> <span>6379</span><span>,</span><br><span>]</span><span>;</span>

Click to expand...

For details see the XenForo Manual: AEtot24h

@eva2000 has also written an in-depth walkthrough around setting up redis and this add-on:
See "Xon's Redis Cache Addon For Xenforo 2.x" from:
community.centminmod.com
Troubleshooting

Please be aware that Redis is very sensitive to latency in a virtual environment. If repeated connection failures or protocol errors are experienced disable any Redis Persistence options.

Options
By default, forum thread counts are cached. In general, this is observable when moving large number of threads from one forum to another, and the total page counts are wrong.




Redis Statistics
Admincp dash board is extended with basic redis statistics:




Debugger Statistics
Include redis timings when using the _debug=1 view for a page

Read Scaling

With the $config['cache']['config']['load_from_replica'] option, reads can be deferred to a singular replica instance. This takes all the options of 'config' (except the replicaconfig)

See the FAQ for configuration samples.

High availability

The Zend component support primary/replica setups with Redis Sentinel support. It does not support Redis multi-master clustering.

• Additionally, this add-on implement caching of thread counts in a forum.
• Redis Sentinel support for high-availability (see FAQ for details).

Licencing

Components licenced under; New BSD

• Credis

Components licenced under; MIT Licence

• XenForo Add-on code

Contributing features or bug fixes
Please create a GitHub Pull request via the "More Information" link.

Contributions

If you appreciate this add-on, please consider a contribution via PayPal. Details will be provide via private conversation.

Please contact me if you wish for different licencing arrangements.