Download the PHP package colourbox/simplesamlphp-module-redis without Composer
On this page you can find all versions of the php package colourbox/simplesamlphp-module-redis. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download colourbox/simplesamlphp-module-redis
More information about colourbox/simplesamlphp-module-redis
Files in colourbox/simplesamlphp-module-redis
Package simplesamlphp-module-redis
Short Description A SimpleSAMLphp module for using Redis for session storage etc.
License MIT
Homepage https://github.com/ColourboxDevelopment/simplesamlphp-module-redis
Informations about the package simplesamlphp-module-redis
Redis module for simpleSAMLphp
Introduction
The Redis module implements the simpleSAMLphp data store API, so Redis can be used for backend storage, i.e. session storage.
Prerequisites
This module requires the following
- simpleSAMLphp v. 1.14.11 (Works with older version, but you should update)
- Redis server, See https://redis.io/ for more information
Installation
First thing to do is to set up your Redis server(s). This is out side the scope of this documentation.
Next you must install this module either by either obtaining the tarball or by installing it via composer. The latter is recommended
composer.phar require colourbox/simplesamlphp-module-redis
This will automatically install "predis/predis" as a dependency for ther module. If you downloaded the module yourself, remember to add predis/predis as a dependency in your composer.json.
See https://github.com/simplesamlphp/composer-module-installer for more information on how to install simpleSAMLphp modules via composer.
You can now enable the module by
touch /var/simplesamlphp/modules/redis/enable
Create /var/simplesamlphp/config/module_redis.php
and set appropriate options
for your Redis server. A configuration file template can be found in the
Redis is used as session store for simpleSAMLphp by setting the following options in config.php
'store.type' => 'redis:Redis'
Configuration options
parameters
Connection parameters for the underlying predis client. See connection parameters for detailsoptions
Client options for the underlying predis client. See options for detailsprefix
Key prefix for all keys stored in Redislifetime
Default lifetime for non-expiring keys in RedisoldHost
configuration for old Redis host when doing rolloverparameters
Connection parameters for the underlying predis clientoptions
Client options for the underlying predis client
Example
Rollover to new server
The module has build in support for doing rolling update to a new Redis host. All writes are only done to the new host, but all reads will fall back to the old host if the value is not found on new host.
How-to
- Start new Redis host
- Add new host to config file (
parameters
andoptions
) and add the old host tooldHost
option - Wait until max session lifetime have expired
- Remove
oldHost
config - Shut down old Redis host
Configuration example
All versions of simplesamlphp-module-redis with dependencies
predis/predis Version ~1.0
simplesamlphp/composer-module-installer Version ^1.1