Files
xen-orchestra/packages/xo-server-auth-github/README.md
2017-02-27 15:42:04 +01:00

1.4 KiB

xo-server-auth-github Build Status

GitHub authentication plugin for XO-Server

This plugin allows GitHub 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:

> npm install --global xo-server-auth-github

Usage

This plugin is based on passport-github, see its documentation for more information about the configuration.

Like all other xo-server plugins, it can be configured directly via the web interface, see the plugin documentation.

Registering XO instance in GitHub

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 you've encountered;
  • fork and create a pull request.

License

AGPL3 © Vates SAS