facebook.md 2.93 KB
Newer Older
Douwe Maan's avatar
Douwe Maan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
# Facebook OAuth2 OmniAuth Provider

To enable the Facebook OmniAuth provider you must register your application with Facebook. Facebook will generate an app ID and secret key for you to use.

1.  Sign in to the [Facebook Developer Platform](https://developers.facebook.com/).

1. Choose "My Apps" > "Add a New App"

1. Select the type "Website"

1. Enter a name for your app. This can be anything. Consider something like "<Organization>'s GitLab" or "<Your Name>'s GitLab" or
something else descriptive.

1. Choose "Create New Facebook App ID"

1. Select a Category, for example "Productivity"

1. Choose "Create App ID"

1. Enter the address of your GitLab installation at the bottom of the package

22
    ![Facebook Website URL](img/facebook_website_url.png)
Douwe Maan's avatar
Douwe Maan committed
23 24 25 26 27 28 29 30

1. Choose "Next"

1. Choose "Skip Quick Start" in the upper right corner

1. Choose "Settings" in the menu on the left

1. Fill in a contact email for your app
31

32
    ![Facebook App Settings](img/facebook_app_settings.png)
Douwe Maan's avatar
Douwe Maan committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

1. Choose "Save Changes"

1. Choose "Status & Review" in the menu on the left

1. Change the switch on the right from No to Yes

1. Choose "Confirm" when prompted to make the app public

1. Choose "Dashboard" in the menu on the left

1. Choose "Show" next to the hidden "App Secret"

1. You should now see an app key and app secret (see screenshot). Keep this page open as you continue configuration.

48
    ![Facebook API Keys](img/facebook_api_keys.png)
Douwe Maan's avatar
Douwe Maan committed
49 50 51 52 53 54

1.  On your GitLab server, open the configuration file.

    For omnibus package:

    ```sh
55
    sudo editor /etc/gitlab/gitlab.rb
Douwe Maan's avatar
Douwe Maan committed
56 57 58 59 60
    ```

    For installations from source:

    ```sh
61
    cd /home/git/gitlab
Douwe Maan's avatar
Douwe Maan committed
62

63
    sudo -u git -H editor config/gitlab.yml
Douwe Maan's avatar
Douwe Maan committed
64 65 66 67 68 69 70 71 72
    ```

1.  See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.

1.  Add the provider configuration:

    For omnibus package:

    ```ruby
73 74 75 76 77 78 79
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "facebook",
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET"
      }
    ]
Douwe Maan's avatar
Douwe Maan committed
80 81 82 83 84
    ```

    For installations from source:

    ```
85 86
    - { name: 'facebook', app_id: 'YOUR_APP_ID',
      app_secret: 'YOUR_APP_SECRET' }
Douwe Maan's avatar
Douwe Maan committed
87 88 89 90 91 92 93 94
    ```

1.  Change 'YOUR_APP_ID' to the API key from Facebook page in step 10.

1.  Change 'YOUR_APP_SECRET' to the API secret from the Facebook page in step 10.

1.  Save the configuration file.

95 96
1.  [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
    installed GitLab via Omnibus or from source respectively.
Douwe Maan's avatar
Douwe Maan committed
97 98

On the sign in page there should now be a Facebook icon below the regular sign in form. Click the icon to begin the authentication process. Facebook will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in.
99 100 101

[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[restart]: ../administration/restart_gitlab.md#installations-from-source