doc/plugins/emailauth.mdwn

   1 [[!template id=plugin name=emailauth core=1 author="[[Joey]]"]]
   2 [[!tag type/auth]]
   3
   4 This plugin lets users log into ikiwiki using any email address. To complete
   5 the login, a one-time-use link is emailed to the user, and they can simply
   6 open that link in their browser.
   7
   8 It is enabled by default, but can be turned off if you want to only use
   9 some other form of authentication, such as [[passwordauth]] or [[openid]].
  10
  11 Users who have logged in using emailauth will have their email address used as
  12 their username. In places where the username is displayed, like the
  13 RecentChanges page, the domain will be omitted, to avoid exposing the
  14 user's email address. In places where the full username needs to be put,
  15 like commits of changes, the email address is cloaked using
  16 <a href="http://xmlns.com/foaf/spec/#term_mbox_sha1sum">the
  17 foaf:mbox_sha1sum spec</a>.
  18
  19 This plugin needs the [[!cpan Mail::SendMail]] perl module installed,
  20 and able to send outgoing email.