You are here

README.txt in simpleSAMLphp Authentication 6.2

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 7.3 README.txt
  3. 7 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 not being set to memcache.


-- 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 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.
  3. -- PREREQUISITES --
  4. 1) You must have SimpleSAMLphp installed and configured as a working service
  5. point (SP) as the module uses your local SimpleSAMLphp SP for the SAML
  6. support. For more information on installing and configuring SimpleSAMLphp as
  7. an SP visit: http://www.simplesamlphp.org.
  8. IMPORTANT: Your SP must be configured to use something other than phpsession
  9. for session storage (in config/config.php set store.type => 'memcache' or 'sql').
  10. To use memcache session handling you must have memcached installed on your
  11. server and PHP must have the memcache extension. For more information on
  12. installing the memcache extension for PHP visit:
  13. http://www.php.net/manual/en/memcache.installation.php
  14. If you are on a shared host or a machine that you cannot install memcache on
  15. then consider using the sql handler (store.type => 'sql').
  16. -- INSTALLATION --
  17. Assuming the prerequisites have been met, installation of this module is just like any other Drupal module.
  18. 1) Download the module
  19. 2) Uncompress it
  20. 3) Move it to the appropriate modules directory (usually, sites/all/modules)
  21. 4) Go to the Drupal module administration page for your site
  22. 5) Enable the module
  23. 6) Configure the module (see below)
  24. -- CONFIGURATION --
  25. 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.
  26. -- TROUBLESHOOTING --
  27. The most common reason for things not working is the SP session storage type not being set to memcache.
  28. -- CONTACT --
  29. Current Maintainers
  30. * Steve Moitozo (geekwisdom) http://drupal.org/user/1662