summaryrefslogtreecommitdiffstats
path: root/doc/integrations/Single-Sign-On/Github.md
blob: 12b2c537e723e2fc15b69ada213f1ed8d4596506 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
## Configuring GitHub Enterprise Single-Sign-On

Follow these steps to configure Mattermost to use GitHub Enterprise as a single-sign-on (SSO) service for team creation, account creation and sign-in.

1. Login to your GitHub Enterprise account and go to the Applications section in Profile Settings.
2. Add a new application called "Mattermost" with the following as Authorization callback URL:
  * `<your-mattermost-url>` (example: http://localhost:8065)

3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _GitLabSettings_ fields in config/config.json

4. Also in config/config.json, set _Enable_ to `true` for the _gitlab_ section, leave _Scope_ blank and use the following for the endpoints:
  * _AuthEndpoint_: `https://<your-github-enterprise-url>/oauth/authorize` (example https://github.com/oauth/authorize)
  * _TokenEndpoint_: `https://<your-github-enterprise-url>/oauth/access_token`
  * _UserApiEndpoint_: `https://<your-github-enterprise-url>/api/v3/user`

5. (Optional) If you would like to force all users to sign-up with GitHub Enterprise only, in the _ServiceSettings_ section of config/config.json set _DisableEmailSignUp_ to `true`.

6. Restart your Mattermost server to see the changes take effect.