ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / openid.mdwn
1 [[!template id=plugin name=openid core=1 author="[[Joey]]"]]
2 [[!tag type/auth]]
3
4 This plugin allows users to use their [OpenID](http://openid.net/) to log
5 into the wiki.
6
7 The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module.
8 Version 1.x is needed in order for OpenID v2 to work.
9
10 The [[!cpan LWPx::ParanoidAgent]] perl module is used if available, for
11 added security. Finally, the [[!cpan Crypt::SSLeay]] perl module is needed
12 to support users entering "https" OpenID urls.
13
14 This plugin is enabled by default, but can be turned off if you want to
15 only use some other form of authentication, such as [[passwordauth]].
16
17 ## options
18
19 These options do not normally need to be set, but can be useful in
20 certain setups.
21
22 * `openid_realm` can be used to control the scope of the openid request.
23   It defaults to the `cgiurl` (or `openid_cgiurl` if set); only allowing
24   ikiwiki's [[CGI]] to authenticate. If you have multiple ikiwiki instances,
25   or other things using openid on the same site, you may choose to put them
26   all in the same realm to improve the user's openid experience. It is an
27   url pattern, so can be set to eg "http://*.example.com/"
28
29 * `openid_cgiurl` can be used to cause a different than usual `cgiurl`
30   to be used when doing openid authentication. The `openid_cgiurl` must
31   point to an ikiwiki [[CGI]], and it will need to match the `openid_realm`
32   to work.