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