diff --git a/README.md b/README.md index ae883f33..6b088fc4 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ - [Google](#google) - [Twitter](#twitter) - [GitHub](#github) + - [GitLab](#gitlab) - [BitBucket](#bitbucket) - [SAML](#saml) - [External Issue Trackers](#external-issue-trackers) @@ -665,6 +666,14 @@ Once you have the Client ID and secret generated, configure them using the `OAUT For example, if your Client ID is `xxx` and the Client secret is `yyy`, then adding `--env='OAUTH_GITHUB_API_KEY=xxx' --env='OAUTH_GITHUB_APP_SECRET=yyy'` to the docker run command enables support for GitHub OAuth. +#### GitLab + +To enable the GitLab OAuth2 OmniAuth provider you must register your application with GitLab. GitLab will generate a Client ID and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/gitlab.html) for the procedure to generate the Client ID and secret with GitLab. + +Once you have the Client ID and secret generated, configure them using the `OAUTH_GITLAB_API_KEY` and `OAUTH_GITLAB_APP_SECRET` environment variables respectively. + +For example, if your Client ID is `xxx` and the Client secret is `yyy`, then adding `--env='OAUTH_GITLAB_API_KEY=xxx' --env='OAUTH_GITLAB_APP_SECRET=yyy'` to the docker run command enables support for GitLab OAuth. + #### BitBucket To enable the BitBucket OAuth2 OmniAuth provider you must register your application with BitBucket. BitBucket will generate a Client ID and secret for you to use. Please refer to the GitLab [documentation](http://doc.gitlab.com/ce/integration/bitbucket.html) for the procedure to generate the Client ID and secret with BitBucket.