X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/22064a9f81d15a51c58434f68ce7f8cc8fc40bbf..64aca7c30b5ffc48546bdd7f3001b0a0b4bae072:/doc/plugins/openid.mdwn?ds=inline diff --git a/doc/plugins/openid.mdwn b/doc/plugins/openid.mdwn index a6e01ccc5..d56d1a396 100644 --- a/doc/plugins/openid.mdwn +++ b/doc/plugins/openid.mdwn @@ -1,24 +1,32 @@ -[[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 [[cpan Net::OpenID::Consumer]] perl module. 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. +The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module. +Version 1.x is needed in order for OpenID v2 to work. -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. +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 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=postsignin`. 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]]. -This plugin is included in ikiwiki, but is not enabled by default. +## options + +These options do not normally need to be set, but can be useful in +certain setups. + +* `openid_realm` can be used to control the scope of the openid request. + It defaults to the `cgiurl` (or `openid_cgiurl` if set); only allowing + ikiwiki's [[CGI]] to authenticate. If you have multiple ikiwiki instances, + or other things using openid on the same site, you may choose to put them + all in the same realm to improve the user's openid experience. It is an + url pattern, so can be set to eg "http://*.example.com/" + +* `openid_cgiurl` can be used to cause a different than usual `cgiurl` + to be used when doing openid authentication. The `openid_cgiurl` must + point to an ikiwiki [[CGI]], and it will need to match the `openid_realm` + to work.