nodebb-plugin-sso-saml/README.md

27 lines
986 B
Markdown
Raw Permalink Normal View History

2014-09-23 11:35:29 +02:00
# NodeBB SAML SSO
2014-09-22 19:38:45 +02:00
2014-09-23 11:35:29 +02:00
NodeBB Plugin that allows users to login/register via SAML IDP
2014-09-22 19:38:45 +02:00
## Installation
2020-04-29 15:26:49 +02:00
1) npm install git+https://code.evin.team/evin/nodebb-plugin-sso-saml.git.
2014-09-23 11:35:29 +02:00
2014-09-23 11:39:17 +02:00
2) Activate plugin at nodebb admin panel.
2014-09-23 11:35:29 +02:00
3) Once you activated it you can configure all the params at SAML section.
- IdP entry point: it's the saml IdP entry point. E.g https://<sever>/simplesaml/saml2/idp/SSOService.php.
- 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.
2014-09-23 11:39:17 +02:00
- Server CRT file: Server crt path. Mandatory if used metadata url.
2014-09-23 11:35:29 +02:00
2014-09-23 11:39:29 +02:00
## Support
2014-09-23 11:35:29 +02:00
2014-09-23 11:39:17 +02:00
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
2014-09-23 11:35:29 +02:00
2014-09-23 11:39:17 +02:00
## About
2014-09-23 11:40:37 +02:00
This plugin has been built on top of passport.saml, for more info visit https://github.com/bergie/passport-saml.