94 lines
2.0 KiB
Markdown
94 lines
2.0 KiB
Markdown
|
# xo-server-auth-google [](https://travis-ci.org/vatesfr/xo-server-auth-google)
|
||
|
|
|
||
|
|
> Google authentication plugin for XO-Server
|
||
|
|
|
||
|
|
This plugin allows Google 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-google):
|
||
|
|
|
||
|
|
```
|
||
|
|
> npm install --global xo-server-auth-google
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
> This plugin is based on [passport-google](https://google.com/jaredhanson/passport-google),
|
||
|
|
> see [its documentation](https://google.com/jaredhanson/passport-google#configure-strategy)
|
||
|
|
> for more information about the configuration.
|
||
|
|
|
||
|
|
### Creating the Google project
|
||
|
|
|
||
|
|
[Create a new project](https://console.developers.google.com/project):
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Enable the Google+ API:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Add OAuth 2.0 credentials:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Add the plugin to XO-Server config
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
plugins:
|
||
|
|
|
||
|
|
auth-google:
|
||
|
|
|
||
|
|
# Both these values will be given to you when your instance of XO
|
||
|
|
# is registered in Google
|
||
|
|
# (https://google.com/settings/developers).
|
||
|
|
clientID: 326211154583-nt2s112d3t7f4f1hh49oo9164nivvbnu.apps.googleusercontent.com
|
||
|
|
clientSecret: -HTDb8I4jXiLRMaRL15qCffQ
|
||
|
|
|
||
|
|
# Must be exactly the same as specified on the Google developer
|
||
|
|
# console.
|
||
|
|
callbackURL: 'http://xo.company.net/signin/google/callback'
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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://google.com/vatesfr/xo-server-auth-google/issues)
|
||
|
|
you've encountered;
|
||
|
|
- fork and create a pull request.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
AGPL3 © [Vates SAS](http://vates.fr)
|