Added Redis session storage documentation

mschwager · mschwager · commit d8a743a85093 · 2017-03-31T15:34:25.000-04:00
diff --git a/docs/simplesamlphp-install.md b/docs/simplesamlphp-install.md
@@ -43,6 +43,8 @@ Prerequisites
    * When using databases:
      * Always: `PDO`
      * Database driver: (`mysql`, `pgsql`, ...)
+ * Support for the following PHP packages:
+   * When saving session information to a Redis server: `predis`
 
 What actual packages are required for the various extensions varies between different platforms and distributions.
 
diff --git a/docs/simplesamlphp-maintenance.md b/docs/simplesamlphp-maintenance.md
@@ -29,6 +29,7 @@ The `store.type` configuration option in `config.php` allows you to select which
   * `phpsession` uses the built in session management in PHP. This is the default, and is simplest to use. It will not work in a load-balanced environment in most configurations.
   * `memcache` uses the memcache software to cache sessions in memory. Sessions can be distributed and replicated among several memcache servers, enabling both load-balancing and fail-over.
   * `sql` stores the session in an SQL database.
+  * `redis` stores the session in Redis.
 
     'store.type' => 'phpsession',
 
@@ -156,6 +157,12 @@ Username and password for accessing the database can be configured in the `store
 
 The required tables are created automatically. If you are storing data from multiple separate SimpleSAMLphp installations in the same database, you can use the `store.sql.prefix` option to prevent conflicts.
 
+### Configuring Redis storage
+
+To store sessions in Redis, set the `store.type` option to `redis`.
+
+By default SimpleSAMLphp will attempt to connect to Redis on the `localhost` at port `6379`. These can be configured via the `store.redis.host` and `store.redis.port` options, respectively. You may also set a key prefix with the `store.redis.prefix` option.
+
 ## Metadata storage
 
 Several metadata storage backends are available by default, including `flatfile`, `serialize`, `mdq` and
