docs: update readme

This commit is contained in:
Julian Lam 2023-08-09 15:39:25 -04:00
parent 5b3e429382
commit 714b58875d
2 changed files with 17 additions and 1 deletions

View file

@ -1,3 +1,19 @@
# NodeBB OAuth2 Multiple Client SSO

This NodeBB plugin allows you to configure logins to multiple configurable OAuth2 endpoints, via the admin backend.
This NodeBB plugin allows you to configure logins to multiple configurable OAuth2 endpoints, via the admin backend.

## Caveat

Different OAuth2 providers adhere to the standard differently.
This plugin is tested primarily against the following providers:

* [Auth0 by Okta](//auth0.com)
* [Okta](//www.okta.com/)

Support for other OAuth2 providers is _explicitly not guaranteed_.
If you'd like to help this plugin play nice with other providers, please
[open an issue](https://github.com/NodeBB/nodebb-plugin-sso-oauth2-multiple/issues).

## Screenshots

![OAuth2 Strategy Editing](./screenshots/configure.png)

BIN
screenshots/configure.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 164 KiB