]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/openid.mdwn
pagestate: switch to use_pagespec
[git.ikiwiki.info.git] / doc / plugins / openid.mdwn
index 2bd686d449cd9f9795034e10a4a16352d7e45aa6..91fc7cddc0a26da6707d5e7ccc47c7adfa1e6a72 100644 (file)
@@ -1,25 +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.
+
+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=postsignin`. Users who
-create an OpenID will then be logged in and sent on their way in the wiki.
-
-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 page. To make the wiki's signin
-page direct users to the affiliate signup page, set the `openidsignup`
-configuration parameter to the URL of the signup page.
+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 included in ikiwiki, but is not enabled by default.
+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]].