]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/openid.mdwn
* Add openidsignup config option.
[ikiwiki.git] / doc / plugins / openid.mdwn
1 [[template id=plugin name=openid included=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 `Net::OpenID::Consumer` perl module. The
8 `LWPx::ParanoidAgent` perl module is used if available, for added
9 security. Finally, the `Crypt::SSLeay` perl module is needed to support
10 users entering "https" OpenID urls.
11
12 This plugin supports the
13 [myopenid.com affiliate program](http://myopenid.com/affiliate_welcome),
14 which can be used to help users sign up for an OpenID and log into your
15 site in a single, unified process. When you create the affiliate, specify a
16 login url like `http://example.com/ikiwiki.cgi?do=postsignin`. Users who
17 create an OpenID will then be logged in and sent on their way in the wiki.
18
19 This plugin has a configuration option. You can set `--openidsignup`
20 to the url of a third-party site where users can sign up for an OpenID. If
21 it's set, the signin page will link to that page. To make the wiki's signin
22 page direct users to the affiliate signup page, set the `openidsignup`
23 configuration parameter to the URL of the signup page.
24
25 This plugin is included in ikiwiki, but is not enabled by default.