X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..1fb5b9f61c114a0151416d2de69b5ea420c6706b:/doc/plugins/openid.mdwn diff --git a/doc/plugins/openid.mdwn b/doc/plugins/openid.mdwn index 344be7de3..91fc7cddc 100644 --- a/doc/plugins/openid.mdwn +++ b/doc/plugins/openid.mdwn @@ -1,12 +1,27 @@ -[[template id=plugin name=openid included=1 author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=openid core=1 author="[[Joey]]"]] +[[!tag type/auth]] This plugin allows users to use their [OpenID](http://openid.net/) to log into the wiki. -The plugin needs the `Net::OpenID::Consumer` perl module. The -`LWPx::ParanoidAgent` perl module is used if available, for added -security. Finally, the `Crypt::SSLeay` perl module is needed to support -users entering "https" OpenID urls. +The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module. +Version 1.x is needed in order for OpenID v2 to work. -This plugin is included in ikiwiki, but is not enabled by default. +The [[!cpan LWPx::ParanoidAgent]] perl module is used if available, for +added security. Finally, the [[!cpan Crypt::SSLeay]] perl module is needed +to support users entering "https" OpenID urls. + +This plugin has a configuration option. You can set `--openidsignup` +to the url of a third-party site where users can sign up for an OpenID. If +it's set, the signin page will link to that site. + +This plugin supports the +[myopenid.com affiliate program](http://myopenid.com/affiliate_welcome), +which can be used to help users sign up for an OpenID and log into your +site in a single, unified process. When you create the affiliate, specify a +login url like `http://example.com/ikiwiki.cgi?do=continue`. Once the +affiliate is created, set `openidsignup` to point to the affiliate's signup +url. + +This plugin is enabled by default, but can be turned off if you want to +only use some other form of authentication, such as [[passwordauth]].