omniauth.md 6.36 KB
Newer Older
Drew Blessing's avatar
Drew Blessing committed
1 2
# OmniAuth

3 4
GitLab leverages OmniAuth to allow users to sign in using Twitter, GitHub, and
other popular services.
Drew Blessing's avatar
Drew Blessing committed
5

6 7 8
Configuring OmniAuth does not prevent standard GitLab authentication or LDAP
(if configured) from continuing to work. Users can choose to sign in using any
of the configured mechanisms.
Drew Blessing's avatar
Drew Blessing committed
9

10 11 12
- [Initial OmniAuth Configuration](#initial-omniauth-configuration)
- [Supported Providers](#supported-providers)
- [Enable OmniAuth for an Existing User](#enable-omniauth-for-an-existing-user)
13
- [OmniAuth configuration sample when using Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab/tree/master#omniauth-google-twitter-github-login)
14

15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
## Supported Providers

This is a list of the current supported OmniAuth providers. Before proceeding
on each provider's documentation, make sure to first read this document as it
contains some settings that are common for all providers.

- [GitHub](github.md)
- [Bitbucket](bitbucket.md)
- [GitLab.com](gitlab.md)
- [Google](google.md)
- [Facebook](facebook.md)
- [Twitter](twitter.md)
- [Shibboleth](shibboleth.md)
- [SAML](saml.md)
- [Crowd](crowd.md)
- [Azure](azure.md)
31
- [Auth0](auth0.md)
32

33
## Initial OmniAuth Configuration
Drew Blessing's avatar
Drew Blessing committed
34

35 36
Before configuring individual OmniAuth providers there are a few global settings
that are in common for all providers that we need to consider.
Drew Blessing's avatar
Drew Blessing committed
37

38
- Omniauth needs to be enabled, see details below for example.
39 40 41 42 43 44
- `allow_single_sign_on` allows you to specify the providers you want to allow to
  automatically create an account. It defaults to `false`. If `false` users must
  be created manually or they will not be able to sign in via OmniAuth.
- `block_auto_created_users` defaults to `true`. If `true` auto created users will
  be blocked by default and will have to be unblocked by an administrator before
  they are able to sign in.
Patricio Cano's avatar
Patricio Cano committed
45 46 47 48 49 50 51

>**Note:**
If you set `block_auto_created_users` to `false`, make sure to only
define providers under `allow_single_sign_on` that you are able to control, like
SAML, Shibboleth, Crowd or Google, or set it to `false` otherwise any user on
the Internet will be able to successfully sign in to your GitLab without
administrative approval.
52 53

To change these settings:
54 55 56 57 58 59 60 61 62

* **For omnibus package**

    Open the configuration file:

    ```sh
    sudo editor /etc/gitlab/gitlab.rb
    ```

Patricio Cano's avatar
Patricio Cano committed
63
    and change:
64

65
    ```ruby
66
    gitlab_rails['omniauth_enabled'] = true
Patricio Cano's avatar
Patricio Cano committed
67 68 69 70 71 72

    # CAUTION!
    # This allows users to login without having a user account first. Define the allowed providers
    # using an array, e.g. ["saml", "twitter"], or as true/false to allow all providers or none.
    # User accounts will be created automatically when authentication was successful.
    gitlab_rails['omniauth_allow_single_sign_on'] = ['saml', 'twitter']
73
    gitlab_rails['omniauth_block_auto_created_users'] = true
74 75 76 77 78
    ```

* **For installations from source**

    Open the configuration file:
Drew Blessing's avatar
Drew Blessing committed
79 80 81 82 83 84 85

    ```sh
    cd /home/git/gitlab

    sudo -u git -H editor config/gitlab.yml
    ```

Patricio Cano's avatar
Patricio Cano committed
86
    and change the following section:
87

88
    ```yaml
89
     ## OmniAuth settings
Drew Blessing's avatar
Drew Blessing committed
90 91
      omniauth:
        # Allow login via Twitter, Google, etc. using OmniAuth providers
92
        enabled: true
Drew Blessing's avatar
Drew Blessing committed
93 94

        # CAUTION!
95 96
        # This allows users to login without having a user account first. Define the allowed providers
        # using an array, e.g. ["saml", "twitter"], or as true/false to allow all providers or none.
Drew Blessing's avatar
Drew Blessing committed
97
        # User accounts will be created automatically when authentication was successful.
98 99
        allow_single_sign_on: ["saml", "twitter"]

Drew Blessing's avatar
Drew Blessing committed
100 101 102
        # Locks down those users until they have been cleared by the admin (default: true).
        block_auto_created_users: true
    ```
103

104 105
Now we can choose one or more of the Supported Providers listed above to continue
the configuration process.
106 107

## Enable OmniAuth for an Existing User
Drew Blessing's avatar
Drew Blessing committed
108

109
Existing users can enable OmniAuth for specific providers after the account is
Patricio Cano's avatar
Patricio Cano committed
110
created. For example, if the user originally signed in with LDAP, an OmniAuth
111 112
provider such as Twitter can be enabled. Follow the steps below to enable an
OmniAuth provider for an existing user.
Drew Blessing's avatar
Drew Blessing committed
113 114

1. Sign in normally - whether standard sign in, LDAP, or another OmniAuth provider.
115 116
1. Go to profile settings (the silhouette icon in the top right corner).
1. Select the "Account" tab.
117
1. Under "Connected Accounts" select the desired OmniAuth provider, such as Twitter.
118 119
1. The user will be redirected to the provider. Once the user authorized GitLab
   they will be redirected back to GitLab.
Drew Blessing's avatar
Drew Blessing committed
120 121

The chosen OmniAuth provider is now active and can be used to sign in to GitLab from then on.
122

Patricio Cano's avatar
Patricio Cano committed
123 124 125 126
## Using Custom Omniauth Providers

>**Note:**
The following information only applies for installations from source.
127

128 129 130 131
GitLab uses [Omniauth](http://www.omniauth.org/) for authentication and already ships
with a few providers pre-installed (e.g. LDAP, GitHub, Twitter). But sometimes that
is not enough and you need to integrate with other authentication solutions. For
these cases you can use the Omniauth provider.
132 133 134

### Steps

135 136
These steps are fairly general and you will need to figure out the exact details
from the Omniauth provider's documentation.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

-   Stop GitLab:

        sudo service gitlab stop

-   Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/Gemfile):

        gem "omniauth-your-auth-provider"

-   If you're using MySQL, install the new Omniauth provider gem by running the following command:

        sudo -u git -H bundle install --without development test postgres --path vendor/bundle --no-deployment

-   If you're using PostgreSQL, install the new Omniauth provider gem by running the following command:

        sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment

    > These are the same commands you used in the [Install Gems section](#install-gems) with `--path vendor/bundle --no-deployment` instead of `--deployment`.

-   Start GitLab:

        sudo service gitlab start

### Examples

162 163
If you have successfully set up a provider that is not shipped with GitLab itself,
please let us know.
164

165 166 167
You can help others by reporting successful configurations and probably share a
few insights or provide warnings for common errors or pitfalls by sharing your
experience [in the public Wiki](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations).
168

169 170
While we can't officially support every possible authentication mechanism out there,
we'd like to at least help those with specific needs.