NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(users): clarify GitHub setup (#6751)

Browse Source
This commit is contained in:
Alex 2023-04-05 10:12:53 +01:00 committed by GitHub
parent 7e4bd30f04
commit 2fdba2eb0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/users.md
View File

@ -111,14 +111,20 @@ Save the configuration and then activate the plugin (button on top).
### GitHub
This plugin allows GitHub users to authenticate to Xen-Orchestra.
This plugin allows any GitHub user to authenticate to Xen-Orchestra.
The first time a user signs in, XO will create a new XO user with the same identifier, without any permissions.
The first time a user signs in, XO will create a new XO user with the same identifier (i.e. GitHub name), with *user* permissions. An existing admin will need to apply the appropriate permissions for your environment.
First you need to configure a new app in your GitHub account:
![](https://raw.githubusercontent.com/vatesfr/xen-orchestra/master/packages/xo-server-auth-github/github.png)
Go to your Github settings > "Developer Settings" > "OAuth Apps" > "New OAuth App".
1. Name your GitHub application under "Application Name".
2. Enter your Xen Orchestra URL (or IP) under "Homepage URL"
3. Add your "Authorization callback URL" (for example, https://homepageUrl/signin/github/callback)
When you get your `clientID` and your `clientSecret`, you can configure them in the GitHub Plugin inside the "Settings/Plugins" view of Xen Orchestra.
Be sure to activate the plugin after you save the configuration (button on top). When it's done, you'll see a link in the login view, this is where you'll go to authenticate: