1
- Redis module for simpleSAMLphp
2
- ==============================
3
-
4
- <!-- {{TOC}} -->
5
-
6
- Introduction
7
- ------------
1
+ # Redis module for simpleSAMLphp
2
+ ## Introduction
8
3
The Redis module implements the simpleSAMLphp data store API, so Redis can be
9
4
used for backend storage, i.e. session storage.
10
5
11
- Prerequisites
12
- -------------
6
+ ## Prerequisites
13
7
This module requires the following
14
8
* simpleSAMLphp v. 1.14.11 (Works with older version, but you should update)
15
9
* Redis server, See https://redis.io/ for more information
16
10
17
- Installation
18
- ------------
11
+ ## Installation
19
12
First thing to do is to set up your Redis server(s). This is out side the scope
20
13
of this documentation.
21
14
@@ -43,8 +36,7 @@ options in config.php
43
36
44
37
'store.type' => 'redis:Redis'
45
38
46
- Configuration options
47
- ---------------------
39
+ ## Configuration options
48
40
* ` parameters ` Connection parameters for the underlying predis client. See
49
41
[ connection parameters] ( https://github.com/nrk/predis/wiki/Connection-Parameters ) for details
50
42
* ` 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 = [
70
62
'lifetime' => 288000
71
63
];
72
64
```
73
- Rollover to new server
74
- ----------------------
65
+
66
+ ## Rollover to new server
75
67
The module has build in support for doing rolling update to a new Redis host.
76
68
All writes are only done to the new host, but all reads will fall back to the old host if
77
69
the value is not found on new host.
@@ -83,7 +75,7 @@ the value is not found on new host.
83
75
* Remove ` oldHost ` config
84
76
* Shut down old Redis host
85
77
86
- ### Configguration example
78
+ ### Configuration example
87
79
```
88
80
$config = [
89
81
// Predis client parameters
0 commit comments