add: session.save_path examples

tuxmartin · michael-grunder · commit 8a39caebe89a · 2024-03-18T15:20:13.000-07:00
diff --git a/README.md b/README.md
@@ -65,11 +65,7 @@ see the [INSTALL.md](./INSTALL.md) page.
 
 ## PHP Session handler
 
-phpredis can be used to store PHP sessions. To do this, configure `session.save_handler` and `session.save_path` in your php.ini to tell phpredis where to store the sessions:
-~~~
-session.save_handler = redis
-session.save_path = "tcp://host1:6379?weight=1, tcp://host2:6379?weight=2&timeout=2.5, tcp://host3:6379?weight=2&read_timeout=2.5"
-~~~
+phpredis can be used to store PHP sessions. To do this, configure `session.save_handler` and `session.save_path` in your php.ini to tell phpredis where to store the sessions.
 
 `session.save_path` can have a simple `host:port` format too, but you need to provide the `tcp://` scheme if you want to use the parameters. The following parameters are available:
 
@@ -84,6 +80,26 @@ Sessions have a lifetime expressed in seconds and stored in the INI variable "se
 The session handler requires a version of Redis supporting `EX` and `NX` options of `SET` command (at least 2.6.12).
 phpredis can also connect to a unix domain socket: `session.save_path = "unix:///var/run/redis/redis.sock?persistent=1&weight=1&database=0"`.
 
+### Examples
+
+Multiple Redis servers:
+~~~
+session.save_handler = redis
+session.save_path = "tcp://host1:6379?weight=1, tcp://host2:6379?weight=2&timeout=2.5, tcp://host3:6379?weight=2&read_timeout=2.5"
+~~~
+
+Login to Redis using username and password:
+~~~
+session.save_handler = redis
+session.save_path = "tcp://127.0.0.1:6379?auth[]=user&auth[]=password"
+~~~
+
+Login to Redis using username, password, and set prefix:
+~~~
+session.save_handler = redis
+session.save_path = "tcp://127.0.0.1:6379?auth[]=user&auth[]=password&prefix=user_PHPREDIS_SESSION:"
+~~~
+
 ### Session locking
 
 **Support**: Locking feature is currently only supported for Redis setup with single master instance (e.g. classic master/slave Sentinel environment).
