You are here

Home » API reference » Social Auth Facebook 8.2

README.txt in Social Auth Facebook 8.2

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * How it works
 * Support requests
 * Maintainers


INTRODUCTION
------------

Social Auth Facebook is a Facebook authentication integration for Drupal. It is
based on the Social Auth and Social API projects.

It adds to the site:

 * A new url: /user/login/facebook
 * A settings form at /admin/config/social-api/social-auth/facebook
 * A Facebook logo in the Social Auth Login block.


REQUIREMENTS
------------

This module requires the following modules:

 * Social Auth (https://drupal.org/project/social_auth)
 * Social API (https://drupal.org/project/social_api)


HOW IT WORKS
------------

The user can click on the Facebook logo on the Social Auth Login block
You can also add a button or link anywhere on the site that points
to /user/login/facebook, so theming and customizing the button or link
is very flexible.

After Facebook has returned the user to your site, the module compares the user
id or email address provided by Facebook. If the user has previously registered
using Facebook or your site already has an account with the same email address,
the user is logged in. If not, a new user account is created. Also, a Facebook
account can be associated with an authenticated user.


INSTALLATION
------------

 * Run composer to install the dependencies.
   composer require "drupal/social_auth_facebook:^2.0"

 * Install the dependencies: Social API and Social Auth.

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-8
   for further information.

 * A more comprehensive installation instruction for Drupal 8 can be found at
   https://www.drupal.org/docs/8/modules/social-api/social-api-2x/social-auth-2x/social-auth-facebook-2x-installation


CONFIGURATION
-------------

 * Add your Facebook App OAuth2 information in Configuration »
   User Authentication » Facebook.

 * Place a Social Auth Login block in Structure » Block Layout.

 * If you already have a Social Auth Login block in the site, rebuild the cache.


SUPPORT REQUESTS
----------------

* Before posting a support request, carefully read the installation
   instructions provided in module documentation page.

 * Before posting a support request, check the Recent Llog entries at
   admin/reports/dblog

 * Once you have done this, you can post a support request at module issue
   queue: https://www.drupal.org/project/issues/social_auth_facebook

 * When posting a support request, please inform if you were able to see any
   errors in the Recent Log entries.


MAINTAINERS
-----------

Current Maintainers:

 * Getulio Valentin Sánchez (gvso) - https://www.drupal.org/u/gvso
 * Himanshu Dixit (himanshu-dixit) - https://www.drupal.org/u/himanshu-dixit

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * How it works

  9.  * Support requests

  10.  * Maintainers

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. Social Auth Facebook is a Facebook authentication integration for Drupal. It is

  17. based on the Social Auth and Social API projects.

  18. 

  19. It adds to the site:

  20. 

  21.  * A new url: /user/login/facebook

  22.  * A settings form at /admin/config/social-api/social-auth/facebook

  23.  * A Facebook logo in the Social Auth Login block.

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. 

  29. This module requires the following modules:

  30. 

  31.  * Social Auth (https://drupal.org/project/social_auth)

  32.  * Social API (https://drupal.org/project/social_api)

  33. 

  34. 

  35. HOW IT WORKS

  36. ------------

  37. 

  38. The user can click on the Facebook logo on the Social Auth Login block

  39. You can also add a button or link anywhere on the site that points

  40. to /user/login/facebook, so theming and customizing the button or link

  41. is very flexible.

  42. 

  43. After Facebook has returned the user to your site, the module compares the user

  44. id or email address provided by Facebook. If the user has previously registered

  45. using Facebook or your site already has an account with the same email address,

  46. the user is logged in. If not, a new user account is created. Also, a Facebook

  47. account can be associated with an authenticated user.

  48. 

  49. 

  50. INSTALLATION

  51. ------------

  52. 

  53.  * Run composer to install the dependencies.

  54.    composer require "drupal/social_auth_facebook:^2.0"

  55. 

  56.  * Install the dependencies: Social API and Social Auth.

  57. 

  58.  * Install as you would normally install a contributed Drupal module. See:

  59.    https://drupal.org/documentation/install/modules-themes/modules-8

  60.    for further information.

  61. 

  62.  * A more comprehensive installation instruction for Drupal 8 can be found at

  63.    https://www.drupal.org/docs/8/modules/social-api/social-api-2x/social-auth-2x/social-auth-facebook-2x-installation

  64. 

  65. 

  66. CONFIGURATION

  67. -------------

  68. 

  69.  * Add your Facebook App OAuth2 information in Configuration »

  70.    User Authentication » Facebook.

  71. 

  72.  * Place a Social Auth Login block in Structure » Block Layout.

  73. 

  74.  * If you already have a Social Auth Login block in the site, rebuild the cache.

  75. 

  76. 

  77. SUPPORT REQUESTS

  78. ----------------

  79. 

  80. * Before posting a support request, carefully read the installation

  81.    instructions provided in module documentation page.

  82. 

  83.  * Before posting a support request, check the Recent Llog entries at

  84.    admin/reports/dblog

  85. 

  86.  * Once you have done this, you can post a support request at module issue

  87.    queue: https://www.drupal.org/project/issues/social_auth_facebook

  88. 

  89.  * When posting a support request, please inform if you were able to see any

  90.    errors in the Recent Log entries.

  91. 

  92. 

  93. MAINTAINERS

  94. -----------

  95. 

  96. Current Maintainers:

  97. 

  98.  * Getulio Valentin Sánchez (gvso) - https://www.drupal.org/u/gvso

  99.  * Himanshu Dixit (himanshu-dixit) - https://www.drupal.org/u/himanshu-dixit