Merge branch 'master' into autotag
[ikiwiki] / 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 has a configuration option. You can set `--openidsignup`
15 to the url of a third-party site where users can sign up for an OpenID. If
16 it's set, the signin page will link to that site.
17
18 This plugin supports the
19 [myopenid.com affiliate program](http://myopenid.com/affiliate_welcome),
20 which can be used to help users sign up for an OpenID and log into your
21 site in a single, unified process. When you create the affiliate, specify a
22 login url like `http://example.com/ikiwiki.cgi?do=continue`. Once the
23 affiliate is created, set `openidsignup` to point to the affiliate's signup
24 url.
25
26 This plugin is enabled by default, but can be turned off if you want to
27 only use some other form of authentication, such as [[passwordauth]].