Mercurial > prosody-modules

changeset 5349:ac9710126e1a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_oauth_external: Add configuration example
author Kim Alvefur <zash@zash.se>
date Sat, 15 Apr 2023 10:54:34 +0200
parents ff539f34769f
children f8ec43db580b
files mod_auth_oauth_external/README.md
diffstat 1 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_auth_oauth_external/README.md	Sat Apr 15 10:46:04 2023 +0200
+++ b/mod_auth_oauth_external/README.md	Sat Apr 15 10:54:34 2023 +0200
@@ -20,6 +20,20 @@
 
 # Configuration
 
+## Example
+
+```lua
+-- authentication = "oauth_external"
+
+oauth_external_discovery_url = "https//auth.example.com/auth/realms/TheRealm/.well-known/openid-configuration"
+oauth_external_token_endpoint = "https//auth.example.com/auth/realms/TheRealm/protocol/openid-connect/token"
+oauth_external_validation_endpoint = "https//auth.example.com/auth/realms/TheRealm/protocol/openid-connect/userinfo"
+oauth_external_username_field = "xmpp_username"
+```
+
+
+## Common
+
 `oauth_external_issuer`
 :   Optional URL string representing the Authorization server identity.