diff mod_http_oauth2/README.markdown @ 5197:164a9875935b

mod_http_oauth2/README: Document config options
author Kim Alvefur <zash@zash.se>
date Fri, 03 Mar 2023 22:48:14 +0100 (22 months ago)
parents df3d521e3c39
children 3235b8bd1e55
line wrap: on
line diff
--- a/mod_http_oauth2/README.markdown	Fri Mar 03 22:03:50 2023 +0100
+++ b/mod_http_oauth2/README.markdown	Fri Mar 03 22:48:14 2023 +0100
@@ -12,7 +12,30 @@
 Configuration
 =============
 
-None currently.
+Dynamic client registration enabled by configuring a JWT key. Algorithm
+defaults to *HS256*.
+
+```lua
+oauth2_registration_key = "securely generated JWT key here"
+oauth2_registration_algorithm = "HS256"
+oauth2_registration_options = { default_ttl = 60 * 60 * 24 * 90 }
+```
+
+Various flows can be disabled and enabled with
+`allowed_oauth2_grant_types` and `allowed_oauth2_response_types`:
+
+```lua
+allowed_oauth2_grant_types = {
+	"authorization_code"; -- authorization code grant
+	"password"; -- resource owner password grant
+}
+
+allowed_oauth2_response_types = {
+	"code"; -- authorization code flow
+    -- "token"; -- implicit flow disabled by default
+}
+```
+
 
 Compatibility
 =============