aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joeyh@joeyh.name>2015-05-13 18:50:40 -0400
committerJoey Hess <joeyh@joeyh.name>2015-05-13 18:50:40 -0400
commite34533d1a0e0fc90a669f7cb3c11cafc6b285b26 (patch)
treedaec6a9fe3b54808cc755fb9f85f992c5a619800 /doc
parent5b459737a50d83ff94490d86d1b9a4438d4b50a1 (diff)
downloadikiwiki-e34533d1a0e0fc90a669f7cb3c11cafc6b285b26.tar
ikiwiki-e34533d1a0e0fc90a669f7cb3c11cafc6b285b26.tar.gz
email auth plugin now works through email address entry
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/emailauth.pm14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/plugins/emailauth.pm b/doc/plugins/emailauth.pm
new file mode 100644
index 000000000..9ba26e40c
--- /dev/null
+++ b/doc/plugins/emailauth.pm
@@ -0,0 +1,14 @@
+[[!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 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.