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.
   8 Version 1.x is needed in order for OpenID v2 to work.
   9
  10 The [[!cpan LWPx::ParanoidAgent]] Perl module is strongly recommended.
  11 The [[!cpan LWP]] module can also be used, but is susceptible to
  12 server-side request forgery.
  13
  14 The [[!cpan Crypt::SSLeay]] Perl module is needed
  15 to support users entering "https" OpenID urls.
  16
  17 This plugin is enabled by default, but can be turned off if you want to
  18 only use some other form of authentication, such as [[passwordauth]].
  19
  20 ## options
  21
  22 These options do not normally need to be set, but can be useful in
  23 certain setups.
  24
  25 * `openid_realm` can be used to control the scope of the openid request.
  26   It defaults to the `cgiurl` (or `openid_cgiurl` if set); only allowing
  27   ikiwiki's [[CGI]] to authenticate. If you have multiple ikiwiki instances,
  28   or other things using openid on the same site, you may choose to put them
  29   all in the same realm to improve the user's openid experience. It is an
  30   url pattern, so can be set to eg "http://*.example.com/"
  31
  32 * `openid_cgiurl` can be used to cause a different than usual `cgiurl`
  33   to be used when doing openid authentication. The `openid_cgiurl` must
  34   point to an ikiwiki [[CGI]], and it will need to match the `openid_realm`
  35   to work.
  36
  37 ## troubleshooting
  38
  39 See [[plugins/openid/troubleshooting]] for a number of issues that may
  40 need to be addressed when setting up ikiwiki to accept OpenID logins reliably.
  41
  42 ## delegation
  43
  44 This plugin does not take care of doing the "server" part of the
  45 OpenID protocol, only the "client" part. In other words, it allows
  46 users to login to your site through OpenID, but is not in itself an
  47 OpenID provider.
  48
  49 It is possible, however, to use your Ikiwiki site as a delegation
  50 point to another OpenID provider. For this, use the
  51 [[ikiwiki/directive/meta/]] directive with the `openid` parameter.