diff options
author | Brenda Wallace <shiny@cpan.org> | 2009-12-28 01:57:51 +0000 |
---|---|---|
committer | Brenda Wallace <shiny@cpan.org> | 2009-12-28 01:57:51 +0000 |
commit | f4459dfedcdea2f2a6078bedf9530deb45b6d52c (patch) | |
tree | 942db6159710f5dd17e0c43a5659e1eec027a9e6 /plugins/CasAuthentication/README | |
parent | 9d3829df9d29581c1d0281e57fda8ba4452ce2c2 (diff) | |
parent | ce8c69a49fc6668a19886ebc354ea5bef808d12a (diff) |
Merge commit 'origin/0.9.x' into 0.9.x
Diffstat (limited to 'plugins/CasAuthentication/README')
-rw-r--r-- | plugins/CasAuthentication/README | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/plugins/CasAuthentication/README b/plugins/CasAuthentication/README new file mode 100644 index 000000000..2ee54dc05 --- /dev/null +++ b/plugins/CasAuthentication/README @@ -0,0 +1,38 @@ +The CAS Authentication plugin allows for StatusNet to handle authentication +through CAS (Central Authentication Service). + +Installation +============ +add "addPlugin('casAuthentication', + array('setting'=>'value', 'setting2'=>'value2', ...);" +to the bottom of your config.php + +Settings +======== +provider_name*: a unique name for this authentication provider. +authoritative (false): Set to true if CAS's responses are authoritative + (if authorative and CAS fails, no other password checking will be done). +autoregistration (false): Set to true if users should be automatically created + when they attempt to login. +email_changeable (true): Are users allowed to change their email address? + (true or false) +password_changeable*: must be set to false. This plugin does not support changing passwords. + +server*: CAS server to authentication against +port (443): Port the CAS server listens on. Almost always 443 +path (): Path on the server to CAS. Usually blank. + +* required +default values are in (parenthesis) + +Example +======= +addPlugin('casAuthentication', array( + 'provider_name'=>'Example', + 'authoritative'=>true, + 'autoregistration'=>true, + 'server'=>'sso-cas.univ-rennes1.fr', + 'port'=>443, + 'path'=>'' +)); + |