116 lines
3.4 KiB
Markdown
116 lines
3.4 KiB
Markdown
---
|
|
stage: Manage
|
|
group: Authentication and Authorization
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# Facebook OAuth 2.0 OmniAuth Provider **(FREE)**
|
|
|
|
To enable the Facebook OmniAuth provider you must register your application with
|
|
Facebook. Facebook generates 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
|
|
|
|
|
|
|
|
1. Choose "Next"
|
|
|
|
1. In the upper-right corner, select **Skip Quick Start**.
|
|
|
|
1. Choose "Settings" in the menu on the left
|
|
|
|
1. Fill in a contact email for your app
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
1. On your GitLab server, open the configuration file.
|
|
|
|
For Omnibus package:
|
|
|
|
```shell
|
|
sudo editor /etc/gitlab/gitlab.rb
|
|
```
|
|
|
|
For installations from source:
|
|
|
|
```shell
|
|
cd /home/git/gitlab
|
|
|
|
sudo -u git -H editor config/gitlab.yml
|
|
```
|
|
|
|
1. Edit the [common configuration file settings](omniauth.md#configure-common-settings)
|
|
to add `facebook` as a single sign-on provider. This enables Just-In-Time
|
|
account provisioning for users who do not have an existing GitLab account.
|
|
|
|
1. Add the provider configuration:
|
|
|
|
For Omnibus package:
|
|
|
|
```ruby
|
|
gitlab_rails['omniauth_providers'] = [
|
|
{
|
|
name: "facebook",
|
|
# label: "Provider name", # optional label for login button, defaults to "Facebook"
|
|
app_id: "YOUR_APP_ID",
|
|
app_secret: "YOUR_APP_SECRET"
|
|
}
|
|
]
|
|
```
|
|
|
|
For installations from source:
|
|
|
|
```yaml
|
|
- { name: 'facebook',
|
|
# label: 'Provider name', # optional label for login button, defaults to "Facebook"
|
|
app_id: 'YOUR_APP_ID',
|
|
app_secret: 'YOUR_APP_SECRET' }
|
|
```
|
|
|
|
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.
|
|
|
|
1. For the changes to take effect:
|
|
- If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure).
|
|
- If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source).
|
|
|
|
On the sign in page there should now be a Facebook icon below the regular sign
|
|
in form. Select the icon to begin the authentication process. Facebook asks the
|
|
user to sign in and authorize the GitLab application. If everything goes well
|
|
the user is returned to GitLab and signed in.
|