kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/integration/facebook.md
Marcel Amirault 33c867b70d Fix whitespace in install and integration docs 
Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues, and cleans up
minor white space issues in install and integration docs
2019-07-11 15:21:26 +00:00

2.9 KiB
Raw Blame History

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.

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

  3. Select the type "Website"

  4. 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.

  5. Choose "Create New Facebook App ID"

  6. Select a Category, for example "Productivity"

  7. Choose "Create App ID"

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

    Facebook Website URL

  9. Choose "Next"

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

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

  12. Fill in a contact email for your app

    Facebook App Settings

  13. Choose "Save Changes"

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

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

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

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

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

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

    Facebook API Keys

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

    For omnibus package:

    sudo editor /etc/gitlab/gitlab.rb

    For installations from source:

    cd /home/git/gitlab

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

  21. See Initial OmniAuth Configuration for initial settings.

  22. Add the provider configuration:

    For omnibus package:

    gitlab_rails['omniauth_providers'] = [
  {
    "name" => "facebook",
    "app_id" => "YOUR_APP_ID",
    "app_secret" => "YOUR_APP_SECRET"
  }
]

    For installations from source:

    - { name: 'facebook', app_id: 'YOUR_APP_ID',
  app_secret: 'YOUR_APP_SECRET' }

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

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

  25. Save the configuration file.

  26. Reconfigure or restart GitLab for the changes to take effect if you installed GitLab via Omnibus or from source respectively.

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.