2015-04-15 17:38:10 +02:00
|
|
|
# xo-server-auth-saml [](https://travis-ci.org/vatesfr/xo-server-auth-saml)
|
|
|
|
|
|
2015-08-28 16:16:32 +02:00
|
|
|
> SAML authentication plugin for XO-Server
|
2015-04-15 17:38:10 +02:00
|
|
|
|
|
|
|
|
This plugin allows SAML users to authenticate to Xen-Orchestra.
|
|
|
|
|
|
|
|
|
|
The first time a user signs in, XO will create a new XO user with the
|
|
|
|
|
same identifier.
|
|
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
Installation of the [npm package](https://npmjs.org/package/xo-server-auth-saml):
|
|
|
|
|
|
|
|
|
|
```
|
2015-09-16 11:57:44 +02:00
|
|
|
> npm install --global xo-server-auth-saml
|
2015-04-15 17:38:10 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2015-08-28 16:16:32 +02:00
|
|
|
> This plugin is based on [passport-saml](https://github.com/bergie/passport-saml),
|
|
|
|
|
> see [its documentation](https://github.com/bergie/passport-saml#configure-strategy)
|
|
|
|
|
> for more information about the configuration.
|
|
|
|
|
|
2016-09-27 15:29:23 +02:00
|
|
|
Like all other xo-server plugins, it can be configured directly via
|
|
|
|
|
the web iterface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
|
2015-04-15 17:38:10 +02:00
|
|
|
|
2015-09-21 10:30:53 +02:00
|
|
|
> Important: When registering your instance to your identity provider,
|
|
|
|
|
> you must configure its callback URL to
|
|
|
|
|
> `http://xo.company.net/signin/saml/callback`!
|
|
|
|
|
|
2015-04-15 17:38:10 +02:00
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
### Installing dependencies
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
> npm install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Compilation
|
|
|
|
|
|
|
|
|
|
The sources files are watched and automatically recompiled on changes.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
> npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Tests
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
> npm run test-dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Contributions
|
|
|
|
|
|
|
|
|
|
Contributions are *very* welcomed, either on the documentation or on
|
|
|
|
|
the code.
|
|
|
|
|
|
|
|
|
|
You may:
|
|
|
|
|
|
|
|
|
|
- report any [issue](https://github.com/vatesfr/xo-server-auth-saml/issues)
|
|
|
|
|
you've encountered;
|
|
|
|
|
- fork and create a pull request.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
AGPL3 © [Vates SAS](http://vates.fr)
|
