Mercurial > prosody-modules

diff mod_auth_oauthbearer/README.markdown @ 3116:1a1affd22f74

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_oauthbearer: expand intro to mention when/how you'd use this
author JC Brand <jc@opkode.com>
date Thu, 14 Jun 2018 09:13:30 +0000
parents 73ada978dabc
children
line wrap: on
line diff
--- a/mod_auth_oauthbearer/README.markdown	Thu Jun 14 09:11:03 2018 +0000
+++ b/mod_auth_oauthbearer/README.markdown	Thu Jun 14 09:13:30 2018 +0000
@@ -9,6 +9,11 @@
 
 This is an authentication module for the SASL OAUTHBEARER mechanism, as provided by `mod_sasl_oauthbearer`.
 
+You can use this to log in via OAuth, for example if you want your user's to log in with Github, Twitter, Reddit etc.
+
+The XMPP client needs get an OAuth token from the provider (e.g. Github) and send that to Prosody.
+This module will then verify that token by calling the `oauth_url` you've configured.
+
 Configuration
 =============