You are here

Home » API reference » External Authentication 8

README.txt in External Authentication 8

Same filename and directory in other branches
  1. 2.0.x README.txt
Description:
============

The ExternalAuth module provides a generic service for logging in and
registering users that are authenticated against an external site or service and
storing the authentication details.
It is the Drupal 8 equivalent of user_external_login_register() and related
functions, as well as the authmap table in Drupal 6 & 7 core.

Usage:
======

Install this module if it's required as dependency for an external
authentication Drupal module. Module authors that provide external
authentication methods can use this helper service to provide a consistent API
for storing and retrieving external authentication data.

Installation:
=============

Installation of this module is just like any other Drupal module.

1) Download the module
2) Uncompress it
3) Move it to the appropriate modules directory (usually, /modules)
4) Go to the Drupal module administration page for your site
5) Enable the module

Upgrading:
==========

The Drupal 8 version of this module provides Migrate functionality to upgrade
your Drupal 6 or Drupal 7 authmap entries to your Drupal 8 installation.

In order to upgrade the authmap table from your Drupal 6 or Drupal 7
installation, follow these instructions:
  - Install and enable the ExternalAuth module as described above.
  - Activate the Migrate and Migrate Drupal core modules and perform your
  upgrade migration.
  See https://www.drupal.org/upgrade/migrate for more information about this
  process.

File

README.txt
View source 
  1. Description:

  2. ============

  3. 

  4. The ExternalAuth module provides a generic service for logging in and

  5. registering users that are authenticated against an external site or service and

  6. storing the authentication details.

  7. It is the Drupal 8 equivalent of user_external_login_register() and related

  8. functions, as well as the authmap table in Drupal 6 & 7 core.

  9. 

  10. Usage:

  11. ======

  12. 

  13. Install this module if it's required as dependency for an external

  14. authentication Drupal module. Module authors that provide external

  15. authentication methods can use this helper service to provide a consistent API

  16. for storing and retrieving external authentication data.

  17. 

  18. Installation:

  19. =============

  20. 

  21. Installation of this module is just like any other Drupal module.

  22. 

  23. 1) Download the module

  24. 2) Uncompress it

  25. 3) Move it to the appropriate modules directory (usually, /modules)

  26. 4) Go to the Drupal module administration page for your site

  27. 5) Enable the module

  28. 

  29. Upgrading:

  30. ==========

  31. 

  32. The Drupal 8 version of this module provides Migrate functionality to upgrade

  33. your Drupal 6 or Drupal 7 authmap entries to your Drupal 8 installation.

  34. 

  35. In order to upgrade the authmap table from your Drupal 6 or Drupal 7

  36. installation, follow these instructions:

  37.   - Install and enable the ExternalAuth module as described above.

  38.   - Activate the Migrate and Migrate Drupal core modules and perform your

  39.   upgrade migration.

  40.   See https://www.drupal.org/upgrade/migrate for more information about this

  41.   process.