diff --git a/README.md b/README.md index 0180bdb..86f1aa2 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ NodeBB Plugin that allows users to login/register via SAML IDP ## Installation - 1) npm install nodebb-plugin-sso-saml + 1) npm install nodebb-plugin-sso-saml. - 2) Activate plugin at nodebb admin panel + 2) Activate plugin at nodebb admin panel. 3) Once you activated it you can configure all the params at SAML section. @@ -14,11 +14,13 @@ NodeBB Plugin that allows users to login/register via SAML IDP - Callback path: path to callback. Eg: /auth/saml/callback. - Issuer: issuer string to supply IdP. Eg: 'nodebb-saml' - Metadata url: url where metadata will be served at. Optional. - - Server CRT file: Server crt path. Mandatory if used metadata url + - Server CRT file: Server crt path. Mandatory if used metadata url. + -### - If you need more info or if you need some help, please report an issue at https://github.com/GeographicaGS/nodebb-plugin-sso-saml/issues +## Support + +If you need more info or if you need some help, please report an issue at https://github.com/GeographicaGS/nodebb-plugin-sso-saml/issues -### - This plugin has been built on top of passport.saml, for more info visit https://github.com/bergie/passport-saml +## About +This plugin has been built on top of passport.saml, for more info visit https://github.com/bergie/passport-saml.