aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/emailauth.mdwn
blob: 4df9700c517104698dc78d8356abba7ccc2d437d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
[[!template id=plugin name=emailauth core=1 author="[[Joey]]"]]
[[!tag type/auth]]

This plugin lets users log into ikiwiki using any email address. To complete
the login, a one-time-use link is emailed to the user, and they can simply
open that link in their browser.

It is (indirectly) enabled by default, but can be turned off if you want to
only use some other form of authentication, such as [[passwordauth]] or
[[openid]].

Users who have logged in using emailauth will have their email address used as
their username. In places where the username is displayed, like the
RecentChanges page, the domain will be omitted, to avoid exposing the
user's email address. In places where the full username needs to be put,
like commits of changes, the email address is cloaked using
<a href="http://xmlns.com/foaf/spec/#term_mbox_sha1sum">the
foaf:mbox_sha1sum spec</a>.

This plugin needs the [[!cpan Mail::Sendmail]] perl module installed,
and able to send outgoing email.