web commit by ManojSrivastava
[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. The
8 [[cpan LWPx::ParanoidAgent]] perl module is used if available, for added
9 security. Finally, the [[cpan Crypt::SSLeay]] perl module is needed to support
10 users entering "https" OpenID urls.
11
12 This plugin has a configuration option. You can set `--openidsignup`
13 to the url of a third-party site where users can sign up for an OpenID. If
14 it's set, the signin page will link to that site.
15
16 This plugin supports the
17 [myopenid.com affiliate program](http://myopenid.com/affiliate_welcome),
18 which can be used to help users sign up for an OpenID and log into your
19 site in a single, unified process. When you create the affiliate, specify a
20 login url like `http://example.com/ikiwiki.cgi?do=continue`. Once the
21 affiliate is created, set `openidsignup` to point to the affiliate's signup
22 url.
23
24 This plugin is enabled by default, but can be turned off if you want to
25 only use some other form of authentication, such as [[passwordauth]].