Update README.md

This commit is contained in:
Alberto Asuero 2014-09-23 11:39:17 +02:00
parent 3e1352729e
commit 919d27c689

View file

@ -4,9 +4,9 @@ NodeBB Plugin that allows users to login/register via SAML IDP
## Installation ## 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. 3) Once you activated it you can configure all the params at SAML section.
@ -14,11 +14,14 @@ NodeBB Plugin that allows users to login/register via SAML IDP
- Callback path: path to callback. Eg: /auth/saml/callback. - Callback path: path to callback. Eg: /auth/saml/callback.
- Issuer: issuer string to supply IdP. Eg: 'nodebb-saml' - Issuer: issuer string to supply IdP. Eg: 'nodebb-saml'
- Metadata url: url where metadata will be served at. Optional. - 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.
## Support and about
###
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 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
### ## About
This plugin has been built on top of passport.saml, for more info visit https://github.com/bergie/passport-saml This plugin has been built on top of passport.saml, for more info visit https://github.com/bergie/passport-saml.
Developed by Alberto Asuero