add note on options formatting; add username for Redis; closes #63

zandbelt · zandbelt · commit a16ed57eb70f · 2024-03-06T08:00:07.000+01:00
Signed-off-by: Hans Zandbelt &lt;hans.zandbelt@openidc.com&gt;
diff --git a/oauth2.conf b/oauth2.conf
@@ -19,9 +19,10 @@
 # Note that this directive must be defined before any OAuth2TokenVerify directive that uses it. 
 #
 # type             shm|file|redis|memcache   cache backend type for access token validation results, default is shm
-# options          <options>                 cache backend specific options, see Cache Options
+# options          <options>                 cache backend specific options in query encoded format, see Cache Options
+#                                            e.g name=myname&password=mypassword&encrypt=false
 #
-#OAuth2Cache <type> [<options>]
+#OAuth2Cache <type> [<options-in-query-encoded-format>]
 #
 #
 # OAuth2Cache Options:
@@ -54,6 +55,7 @@
 #
 # host                     <string> (localhost)           Redis server hostname
 # port                     <number> (6379)                Redis servver port
+# username                 <string> (<no authentication>) username used to authenticate to the Redis server
 # password                 <string> (<no authentication>) password used to authenticate to the Redis server
 
 

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,10 @@`
`19`	`19`	`# Note that this directive must be defined before any OAuth2TokenVerify directive that uses it.`
`20`	`20`	`#`
`21`	`21`	`# type shm\|file\|redis\|memcache cache backend type for access token validation results, default is shm`
`22`		`-# options <options> cache backend specific options, see Cache Options`
	`22`	`+# options <options> cache backend specific options in query encoded format, see Cache Options`
	`23`	`+# e.g name=myname&password=mypassword&encrypt=false`
`23`	`24`	`#`
`24`		`-#OAuth2Cache <type> [<options>]`
	`25`	`+#OAuth2Cache <type> [<options-in-query-encoded-format>]`
`25`	`26`	`#`
`26`	`27`	`#`
`27`	`28`	`# OAuth2Cache Options:`
`@@ -54,6 +55,7 @@`
`54`	`55`	`#`
`55`	`56`	`# host <string> (localhost) Redis server hostname`
`56`	`57`	`# port <number> (6379) Redis servver port`
	`58`	`+# username <string> (<no authentication>) username used to authenticate to the Redis server`
`57`	`59`	`# password <string> (<no authentication>) password used to authenticate to the Redis server`
`58`	`60`
`59`	`61`