glowingblue / redis-setup
Makes it easy to enable/disable Redis features: Cache, Queue & Sessions
Installs: 25 785
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 1
Type:flarum-extension
pkg:composer/glowingblue/redis-setup
Requires
- php: ^8.1
- flarum/core: ^1.8.5
- fof/redis: ^1.1.4
Requires (Dev)
- flarum/phpstan: *
- fof/horizon: ^1.0
README
A Flarum extension.
Makes it easy to enable/disable Redis features:
- Cache
- Queue
- Sessions
If you are using a local redis setup, you will likely be able to simply use the defaults provided. Any of these can be overridden using environment variables as follows:
REDIS_HOST='127.0.0.1 # Optional, else uses default REDIS_PORT=6379 # Optional, else uses default REDIS_PASSWORD=null # Optional, otherwise null REDIS_DATABASE_CACHE=1 # Optional, else uses default REDIS_DATABASE_QUEUE=2 # Optional, else uses default REDIS_DATABASE_SESSION=3 # Optional, else uses default REDIS_PREFIX='flarum_' # Optional, else uses default
📥 Installation
composer require glowingblue/redis-setup
♻ Updating
composer update glowingblue/redis-setup php flarum cache:clear
Compatibility with fof/redis
This extension depends on fof/redis and deliberately disables the settings service that fof/redis ≥ 1.1 provides.
fof/redis's settings service replaces Flarum's SettingsRepositoryInterface with a Redis-backed caching layer. However, this extension reads settings (e.g. which Redis services to enable) during its own boot sequence — before Redis is fully wired into the container. Enabling the Redis settings cache here would create a circular dependency: configuring Redis requires reading settings, but reading settings requires Redis.
The settings service from fof/redis is therefore always disabled in this extension's extender. If you want Redis-backed settings caching, configure fof/redis directly in your project's root extend.php instead of using this extension.