1- Redis module for simpleSAMLphp
2- ==============================
3-
4- <!-- {{TOC}} -->
5-
6- Introduction
7- ------------
1+ # Redis module for simpleSAMLphp
2+ ## Introduction
83The Redis module implements the simpleSAMLphp data store API, so Redis can be
94used for backend storage, i.e. session storage.
105
11- Prerequisites
12- -------------
6+ ## Prerequisites
137This module requires the following
148* simpleSAMLphp v. 1.14.11 (Works with older version, but you should update)
159* Redis server, See https://redis.io/ for more information
1610
17- Installation
18- ------------
11+ ## Installation
1912First thing to do is to set up your Redis server(s). This is out side the scope
2013of this documentation.
2114
@@ -43,8 +36,7 @@ options in config.php
4336
4437 'store.type' => 'redis:Redis'
4538
46- Configuration options
47- ---------------------
39+ ## Configuration options
4840* ` parameters ` Connection parameters for the underlying predis client. See
4941[ connection parameters] ( https://github.com/nrk/predis/wiki/Connection-Parameters ) for details
5042* ` options ` Client options for the underlying predis client. See [ options] ( https://github.com/nrk/predis/wiki/Client-Options ) for details
@@ -70,8 +62,8 @@ $config = [
7062 'lifetime' => 288000
7163];
7264```
73- Rollover to new server
74- ----------------------
65+
66+ ## Rollover to new server
7567The module has build in support for doing rolling update to a new Redis host.
7668All writes are only done to the new host, but all reads will fall back to the old host if
7769the value is not found on new host.
@@ -83,7 +75,7 @@ the value is not found on new host.
8375* Remove ` oldHost ` config
8476* Shut down old Redis host
8577
86- ### Configguration example
78+ ### Configuration example
8779```
8880$config = [
8981 // Predis client parameters
0 commit comments