README 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. The CAS Authentication plugin allows for StatusNet to handle authentication
  2. through CAS (Central Authentication Service).
  3. Installation
  4. ============
  5. add "addPlugin('casAuthentication',
  6. array('setting'=>'value', 'setting2'=>'value2', ...);"
  7. to the bottom of your config.php
  8. Settings
  9. ========
  10. provider_name*: a unique name for this authentication provider.
  11. authoritative (false): Set to true if CAS's responses are authoritative
  12. (if authorative and CAS fails, no other password checking will be done).
  13. autoregistration (false): Set to true if users should be automatically created
  14. when they attempt to login.
  15. email_changeable (true): Are users allowed to change their email address?
  16. (true or false)
  17. password_changeable*: must be set to false. This plugin does not support changing passwords.
  18. server*: CAS server to authentication against
  19. port (443): Port the CAS server listens on. Almost always 443
  20. path (): Path on the server to CAS. Usually blank.
  21. takeOverLogin (false): Take over the main login action. If takeOverLogin is
  22. set, anytime the standard username/password login form would be shown,
  23. a CAS login will be done instead.
  24. * required
  25. default values are in (parenthesis)
  26. Example
  27. =======
  28. addPlugin('casAuthentication', array(
  29. 'provider_name'=>'Example',
  30. 'authoritative'=>true,
  31. 'autoregistration'=>true,
  32. 'server'=>'sso-cas.univ-rennes1.fr',
  33. 'port'=>443,
  34. 'path'=>'',
  35. 'takeOverLogin'=>true
  36. ));