You are here

README.txt in simpleSAMLphp Authentication 7

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6.2 README.txt
  3. 7.3 README.txt
  4. 7.2 README.txt
-- SUMMARY --

The simplesamlphp_auth module makes it possible for Drupal to support SAML for
authentication of users. The module will auto-provision user accounts into
Drupal if you want it to. It can also dynamically assign Drupal roles based on
identity attribute values.


-- PREREQUISITES --

1) You must have SimpleSAMLphp installed and configured as a working service
   point (SP) as the module uses your local SimpleSAMLphp SP for the SAML
   support. For more information on installing and configuring SimpleSAMLphp as
   an SP visit: http://www.simplesamlphp.org.

   IMPORTANT: Your SP must be configured to use something other than phpsession
   for session storage (in config/config.php set store.type => 'memcache' or 'sql').

   To use memcache session handling you must have memcached installed on your
   server and PHP must have the memcache extension. For more information on
   installing the memcache extension for PHP visit:
   http://www.php.net/manual/en/memcache.installation.php

   If you are on a shared host or a machine that you cannot install memcache on
   then consider using the sql handler (store.type => 'sql').


-- INSTALLATION --

Assuming the prerequisites have been met, 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, sites/all/modules)
4) Go to the Drupal module administration page for your site
5) Enable the module
6) Configure the module (see below)


-- CONFIGURATION --

The configuration of the module is fairly straight forward. You will need to
know the names of the attributes that your SP will be making available to the
module in order to map them into Drupal.


-- TROUBLESHOOTING --

The most common reason for things not working is the SP session storage type
is still set to phpsession.


-- CONTACT --

Current Maintainers
* Steve Moitozo (geekwisdom) http://drupal.org/user/1662

File

README.txt
View source
  1. -- SUMMARY --
  2. The simplesamlphp_auth module makes it possible for Drupal to support SAML for
  3. authentication of users. The module will auto-provision user accounts into
  4. Drupal if you want it to. It can also dynamically assign Drupal roles based on
  5. identity attribute values.
  6. -- PREREQUISITES --
  7. 1) You must have SimpleSAMLphp installed and configured as a working service
  8. point (SP) as the module uses your local SimpleSAMLphp SP for the SAML
  9. support. For more information on installing and configuring SimpleSAMLphp as
  10. an SP visit: http://www.simplesamlphp.org.
  11. IMPORTANT: Your SP must be configured to use something other than phpsession
  12. for session storage (in config/config.php set store.type => 'memcache' or 'sql').
  13. To use memcache session handling you must have memcached installed on your
  14. server and PHP must have the memcache extension. For more information on
  15. installing the memcache extension for PHP visit:
  16. http://www.php.net/manual/en/memcache.installation.php
  17. If you are on a shared host or a machine that you cannot install memcache on
  18. then consider using the sql handler (store.type => 'sql').
  19. -- INSTALLATION --
  20. Assuming the prerequisites have been met, installation of this module is just like any other Drupal module.
  21. 1) Download the module
  22. 2) Uncompress it
  23. 3) Move it to the appropriate modules directory (usually, sites/all/modules)
  24. 4) Go to the Drupal module administration page for your site
  25. 5) Enable the module
  26. 6) Configure the module (see below)
  27. -- CONFIGURATION --
  28. The configuration of the module is fairly straight forward. You will need to
  29. know the names of the attributes that your SP will be making available to the
  30. module in order to map them into Drupal.
  31. -- TROUBLESHOOTING --
  32. The most common reason for things not working is the SP session storage type
  33. is still set to phpsession.
  34. -- CONTACT --
  35. Current Maintainers
  36. * Steve Moitozo (geekwisdom) http://drupal.org/user/1662