]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/emailauth.mdwn
Merge branch 'master' into debian-jessie-backports
[git.ikiwiki.info.git] / doc / plugins / emailauth.mdwn
index db22e29319423cf03b2eb73afcea89db23c53e60..46366653545d84ba9c0a7d0b9cf4dc0c056dfd9e 100644 (file)
@@ -5,14 +5,17 @@ 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 enabled by default, but can be turned off if you want to only use
-some other form of authentication, such as [[passwordauth]] or [[openid]].
+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. Note though that the email address will be visible
-when looking at eg, commits in the git repository.
+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.