You are here

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. This project is part of the Drupal Social Initiative
  4. (https://groups.drupal.org/social-initiative).
  5. Social Auth is part of the Social API. It provides a common interface for
  6. creating modules related to user registration/login through social networks'
  7. accounts.
  8. * This module defines a path /admin/config/social-api/social-auth which
  9. displays a table of implementers (modules to register/login through social
  10. networks' accounts).
  11. * It also provides a block Social Auth Login which contains links to login
  12. users through the enabled social networks' module clients
  13. * Alternatively, site builders can place (and theme) a link to
  14. user/login/{social_network} wherever on the site. This path are added by the
  15. implementers. For instance Social Auth Facebook will add the path
  16. user/login/facebook
  17. REQUIREMENTS
  18. ------------
  19. This module requires the following modules:
  20. * Social API (https://www.drupal.org/project/social_api)
  21. INSTALLATION
  22. ------------
  23. * Install as you would normally install a contributed Drupal module. See:
  24. https://www.drupal.org/node/1897420 for further information.
  25. CONFIGURATION
  26. -------------
  27. * A table of implementers will be displayed at Administration » Configuration »
  28. Social API Settings » User authentication. However, it will be empty as we
  29. have not enabled an implementer yet.
  30. * You should install implementer modules to get this module start working.
  31. * You can place a Social Auth Login block at Administration » Structure »
  32. Block layout.
  33. * You can find a more comprehensive guide in the Social Auth documentation
  34. (https://www.drupal.org/node/2763731)
  35. UPDATES IN V2
  36. -------------
  37. * An important aspect is that Social Auth now has its own content entity, so
  38. data can be stored in database.
  39. * Unique IDs are now fetched from providers and are associated with a Drupal
  40. user. This allows a user to have multiple accounts from different providers
  41. associated to the same Drupal account.
  42. MAINTAINERS
  43. -----------
  44. Current maintainers:
  45. * gvso - https://www.drupal.org/u/gvso
  46. * himanshu-dixit - https://www.drupal.org/u/himanshu-dixit
  47. Supporting organizations:
  48. * Google Summer of Code (https://www.drupal.org/google-summer-of-code-0)