Merge pull request #534 from mattermost/it33-patch-7

Adding documentation on configuring GitLab SSO
This commit is contained in:
Christopher Speller
2015-09-01 08:28:10 -04:00

View File

@@ -0,0 +1,19 @@
## Configuring GitLab Single-Sign-On
The following steps can be used to configure Mattermost to use GitLab as a single-sign-on (SSO) service for team creation, account creation and sign-in.
1. Login to your GitLab account and go to the Applications section either in Profile Settings or Admin Area.
2. Add a new application called "Mattermost" with the following as Redirect URIs:
* `<your-mattermost-url>/login/gitlab/complete` (example: http://localhost:8065/login/gitlab/complete)
* `<your-mattermost-url>/signup/gitlab/complete`
3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _SSOSettings_ fields in config/config.json
4. Also in config/config.json, set _Allow_ to `true` for the _gitlab_ section, leave _Scope_ blank and use the following for the endpoints:
* _AuthEndpoint_: `<your-gitlab-url>/oauth/authorize` (example http://localhost:3000/oauth/authorize)
* _TokenEndpoint_: `<your-gitlab-url>/oauth/token`
* _UserApiEndpoint_: `<your-gitlab-url>/api/v3/user`
6. (Optional) If you would like to force all users to sign-up with GitLab only, in the _ServiceSettings_ section of config/config.json please set _AllowEmailSignUp_ to `false`.
7. Restart your Mattermost server to see the changes take effect.