From 2fdba2eb0f242a15eeb12a286e8d57cf0db81bf8 Mon Sep 17 00:00:00 2001 From: Alex <5160835+litecactus@users.noreply.github.com> Date: Wed, 5 Apr 2023 10:12:53 +0100 Subject: [PATCH] docs(users): clarify GitHub setup (#6751) --- docs/users.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/users.md b/docs/users.md index 4b8f97b23..efcfbf468 100644 --- a/docs/users.md +++ b/docs/users.md @@ -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: