Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-10-19 15:57:54 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-10-19 15:57:54 +0300
commit419c53ec62de6e97a517abd5fdd4cbde3a942a34 (patch)
tree1f43a548b46bca8a5fb8fe0c31cef1883d49c5b6 /doc/integration/facebook.md
parent1da20d9135b3ad9e75e65b028bffc921aaf8deb7 (diff)
Add latest changes from gitlab-org/gitlab@16-5-stable-eev16.5.0-rc42
Diffstat (limited to 'doc/integration/facebook.md')
-rw-r--r--doc/integration/facebook.md90
1 files changed, 51 insertions, 39 deletions
diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md
index 299b1e53ff2..a1bc4582d51 100644
--- a/doc/integration/facebook.md
+++ b/doc/integration/facebook.md
@@ -1,70 +1,76 @@
---
stage: Govern
-group: Authentication and Authorization
+group: Authentication
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
---
# Use Facebook as an OAuth 2.0 authentication provider **(FREE ALL)**
-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.
+You can use the Facebook OmniAuth provider to authenticate users with their Facebook account.
-1. Sign in to the [Facebook Developer Platform](https://developers.facebook.com/).
+To enable the Facebook OmniAuth provider, you must:
-1. Choose "My Apps" &gt; "Add a New App"
+- Register your application with Facebook. Facebook generates an app ID and a secret key for you to use.
+- Configure the GitLab server.
-1. Select the type "Website"
+## Register your application with Facebook
-1. Enter a name for your app. This can be anything. Consider something like
- "&lt;Organization&gt;'s GitLab" or "&lt;Your Name&gt;'s GitLab" or something
- else descriptive.
+1. Sign in to your [Facebook developer account](https://developers.facebook.com/).
-1. Choose "Create New Facebook App ID"
+1. Go to **My Apps** > **Create App**, then complete the following steps:
-1. Select a Category, for example "Productivity"
+ 1. Enter a descriptive name for your app. For example: **`<your_organization's>` GitLab** or **`<your_name's>` GitLab**.
-1. Choose "Create App ID"
+ 1. Select **Create New Facebook App ID**.
-1. Enter the address of your GitLab installation at the bottom of the package
+ 1. Select a **Category**. For example **Productivity**.
- ![Facebook Website URL](img/facebook_website_url.png)
+ 1. Select **Create App ID**.
-1. Choose "Next"
+ 1. At the bottom of the page, enter the address of your GitLab installation.
+
+ ![Facebook Website URL](img/facebook_website_url.png)
+
+ 1. Select **Next**.
1. In the upper-right corner, select **Skip Quick Start**.
-1. Choose "Settings" in the menu on the left
+1. From the menu on the left, select **Settings**, then complete the following:
+
+ 1. Enter a contact email for your app.
+
+ ![Facebook App Settings](img/facebook_app_settings.png)
-1. Fill in a contact email for your app
+ 1. Select **Save Changes**.
- ![Facebook App Settings](img/facebook_app_settings.png)
+1. From the menu on the left, select **Status & Review**, then complete the following:
-1. Choose "Save Changes"
+ 1. Change the switch on the right from **No** to **Yes**.
-1. Choose "Status & Review" in the menu on the left
+ 1. When prompted to make the app public, select **Confirm**.
-1. Change the switch on the right from No to Yes
+1. From the menu on the left, select **Dashboard**, then complete the following:
-1. Choose "Confirm" when prompted to make the app public
+ 1. Next to the hidden **App Secret**, select **Show**.
-1. Choose "Dashboard" in the menu on the left
+ 1. Copy the **App ID** and **App Secret**. Keep this page
+ open as you continue configuration.
-1. Choose "Show" next to the hidden "App Secret"
+ ![Facebook API Keys](img/facebook_api_keys.png)
-1. You should now see an app key and app secret (see screenshot). Keep this page
- open as you continue configuration.
+## Configure the GitLab server
- ![Facebook API Keys](img/facebook_api_keys.png)
+1. On your GitLab server, open the configuration file:
-1. On your GitLab server, open the configuration file.
+ ::Tabs
- For Linux package installations:
+ :::TabTitle Linux package installations
```shell
sudo editor /etc/gitlab/gitlab.rb
```
- For self-compiled installations:
+ :::TabTitle Self-compiled installations
```shell
cd /home/git/gitlab
@@ -72,13 +78,17 @@ Facebook. Facebook generates an app ID and secret key for you to use.
sudo -u git -H editor config/gitlab.yml
```
+ ::EndTabs
+
1. Configure the [common 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.
+1. Add the provider configuration:
+
+ ::Tabs
- For Linux package installations:
+ :::TabTitle Linux package installations
```ruby
gitlab_rails['omniauth_providers'] = [
@@ -91,7 +101,7 @@ Facebook. Facebook generates an app ID and secret key for you to use.
]
```
- For self-compiled installations:
+ :::TabTitle Self-compiled installations
```yaml
- { name: 'facebook',
@@ -100,9 +110,13 @@ Facebook. Facebook generates an app ID and secret key for you to use.
app_secret: 'YOUR_APP_SECRET' }
```
-1. Change 'YOUR_APP_ID' to the API key from Facebook page in step 10.
+ ::EndTabs
+
+1. In the provide configuration, paste the following values:
+
+ 1. `YOUR_APP_ID`: The **App ID** you copied in the previous step.
-1. Change 'YOUR_APP_SECRET' to the API secret from the Facebook page in step 10.
+ 1. `YOUR_APP_SECRET`: The **App Secret** you copied in the previous step.
1. Save the configuration file.
@@ -110,7 +124,5 @@ Facebook. Facebook generates an app ID and secret key for you to use.
- If you installed using the Linux package, [reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation).
- If you self-compiled your installation, [restart GitLab](../administration/restart_gitlab.md#self-compiled-installations).
-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.
+On the sign in page, a Facebook icon should now appear below the sign-in fields.
+The user can select the icon to sign in.