You are here

Home » API reference » Social Auth 3.x

README.txt in Social Auth 3.x

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
INTRODUCTION
------------

This project is part of the Drupal Social Initiative
(https://groups.drupal.org/social-initiative).

Social Auth is part of the Social API. It provides a common interface for
creating modules related to user registration/login through social networks'
accounts.

 * This module defines a path /admin/config/social-api/social-auth which
   displays a table of implementers (modules to register/login through social
   networks' accounts).

 * It also provides a block Social Auth Login which contains links to login
   users through the enabled social networks' module clients

 * Alternatively, site builders can place (and theme) a link to
   user/login/{social_network} wherever on the site. This path are added by the
   implementers. For instance Social Auth Facebook will add the path
   user/login/facebook

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

This module requires the following modules:

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

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

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/node/1897420 for further information.

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

 * A table of implementers will be displayed at Administration » Configuration »
   Social API Settings » User authentication. However, it will be empty as we
   have not enabled an implementer yet.

 * You should install implementer modules to get this module start working.

 * You can place a Social Auth Login block at Administration » Structure »
   Block layout.

 * You can find a more comprehensive guide in the Social Auth documentation
   (https://www.drupal.org/node/2763731)

UPDATES IN V2
-------------
 * An important aspect is that Social Auth now has its own content entity, so
   data can be stored in database.

 * Unique IDs are now fetched from providers and are associated with a Drupal
   user. This allows a user to have multiple accounts from different providers
   associated to the same Drupal account.

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

Current maintainers:
 * gvso - https://www.drupal.org/u/gvso
 * himanshu-dixit - https://www.drupal.org/u/himanshu-dixit

Supporting organizations:

 * Google Summer of Code (https://www.drupal.org/google-summer-of-code-0)

File

README.txt
View source 
  1. INTRODUCTION

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

  3. 

  4. This project is part of the Drupal Social Initiative

  5. (https://groups.drupal.org/social-initiative).

  6. 

  7. Social Auth is part of the Social API. It provides a common interface for

  8. creating modules related to user registration/login through social networks'

  9. accounts.

  10. 

  11.  * This module defines a path /admin/config/social-api/social-auth which

  12.    displays a table of implementers (modules to register/login through social

  13.    networks' accounts).

  14. 

  15.  * It also provides a block Social Auth Login which contains links to login

  16.    users through the enabled social networks' module clients

  17. 

  18.  * Alternatively, site builders can place (and theme) a link to

  19.    user/login/{social_network} wherever on the site. This path are added by the

  20.    implementers. For instance Social Auth Facebook will add the path

  21.    user/login/facebook

  22. 

  23. REQUIREMENTS

  24. ------------

  25. 

  26. This module requires the following modules:

  27. 

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

  29. 

  30. INSTALLATION

  31. ------------

  32. 

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

  34.    https://www.drupal.org/node/1897420 for further information.

  35. 

  36. CONFIGURATION

  37. -------------

  38. 

  39.  * A table of implementers will be displayed at Administration » Configuration »

  40.    Social API Settings » User authentication. However, it will be empty as we

  41.    have not enabled an implementer yet.

  42. 

  43.  * You should install implementer modules to get this module start working.

  44. 

  45.  * You can place a Social Auth Login block at Administration » Structure »

  46.    Block layout.

  47. 

  48.  * You can find a more comprehensive guide in the Social Auth documentation

  49.    (https://www.drupal.org/node/2763731)

  50. 

  51. UPDATES IN V2

  52. -------------

  53.  * An important aspect is that Social Auth now has its own content entity, so

  54.    data can be stored in database.

  55. 

  56.  * Unique IDs are now fetched from providers and are associated with a Drupal

  57.    user. This allows a user to have multiple accounts from different providers

  58.    associated to the same Drupal account.

  59. 

  60. MAINTAINERS

  61. -----------

  62. 

  63. Current maintainers:

  64.  * gvso - https://www.drupal.org/u/gvso

  65.  * himanshu-dixit - https://www.drupal.org/u/himanshu-dixit

  66. 

  67. Supporting organizations:

  68. 

  69.  * Google Summer of Code (https://www.drupal.org/google-summer-of-code-0)