aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joeyh@joeyh.name>2015-05-13 23:38:56 -0400
committerJoey Hess <joeyh@joeyh.name>2015-05-13 23:38:56 -0400
commitcfb2c22906f41d4a4dd1c3404e8e430a35c1cd41 (patch)
treeb2f0271a5fa334530b3ac3051ad42bc02172a708 /doc
parentee2905ae0a2786fd5f195fdc1779a34b5f62c1d9 (diff)
parentbf8b7fe2d1602827f7419521d140bac4be6200a8 (diff)
downloadikiwiki-cfb2c22906f41d4a4dd1c3404e8e430a35c1cd41.tar
ikiwiki-cfb2c22906f41d4a4dd1c3404e8e430a35c1cd41.tar.gz
Merge branch 'emailauth'
Diffstat (limited to 'doc')
-rw-r--r--doc/basewiki.mdwn2
-rw-r--r--doc/plugins/emailauth.pm17
-rw-r--r--doc/plugins/write.mdwn3
-rw-r--r--doc/style.css20
-rw-r--r--doc/templates.mdwn5
-rw-r--r--doc/wikiicons/emaillogin.pngbin0 -> 685 bytes
6 files changed, 34 insertions, 13 deletions
diff --git a/doc/basewiki.mdwn b/doc/basewiki.mdwn
index 8392884eb..b4aa60c78 100644
--- a/doc/basewiki.mdwn
+++ b/doc/basewiki.mdwn
@@ -10,7 +10,7 @@ It currently includes these pages:
* [[templates]]
* [[ikiwiki/formatting]]
* [[ikiwiki/markdown]]
-* [[ikiwiki/openid]]
+* [[ikiwiki/login-selector]]
* [[ikiwiki/pagespec]]
* [[ikiwiki/directive]]
* [[ikiwiki/subpage]]
diff --git a/doc/plugins/emailauth.pm b/doc/plugins/emailauth.pm
new file mode 100644
index 000000000..8cb060e93
--- /dev/null
+++ b/doc/plugins/emailauth.pm
@@ -0,0 +1,17 @@
+[[!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.
+
+This plugin needs the [[!cpan Mail::SendMail]] perl module installed,
+and able to send outgoing email.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index c3f531b66..95f4a39df 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -458,6 +458,9 @@ object's "name" parameter to the authenticated user's name. Note that
if the name is set to the name of a user who is not registered,
a basic registration of the user will be automatically performed.
+Auth plugins can use the loginselector helper plugin to let the user
+select which authentication method to use.
+
### <a name="sessioncgi">sessioncgi</a>
hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
diff --git a/doc/style.css b/doc/style.css
index fe1eb903d..f0846c0d6 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -465,40 +465,40 @@ li.L8 { list-style: upper-alpha; }
display: none;
}
-/* openid selector */
-#openid_choice {
+/* login selector */
+#login_choice {
display: none;
}
-#openid_input_area {
+#login_input_area {
clear: both;
padding: 10px;
}
-#openid_btns, #openid_btns br {
+#login_btns, #login_btns br {
clear: both;
}
-#openid_highlight {
+#login_highlight {
background-color: black;
float: left;
}
-.openid_large_btn {
+.login_large_btn {
padding: 1em 1.5em;
border: 1px solid #DDD;
margin: 3px;
float: left;
}
-.openid_small_btn {
+.login_small_btn {
padding: 4px 4px;
border: 1px solid #DDD;
margin: 3px;
float: left;
}
-a.openid_large_btn:focus {
+a.login_large_btn:focus {
outline: none;
}
-a.openid_large_btn:focus {
+a.login_large_btn:focus {
outline-style: none;
}
-.openid_selected {
+.login_selected {
border: 4px solid #DDD;
}
diff --git a/doc/templates.mdwn b/doc/templates.mdwn
index 80372fcb7..c45316e44 100644
--- a/doc/templates.mdwn
+++ b/doc/templates.mdwn
@@ -92,8 +92,9 @@ Here is a full list of the template files used:
* `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
`editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
`editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
- `passwordmail.tmpl`, `openid-selector.tmpl`, `revert.tmpl` - Parts of ikiwiki's user
- interface; do not normally need to be customised.
+ `passwordmail.tmpl`, `emailauth.tmpl, `login-selector.tmpl`,
+ `revert.tmpl` - Parts of ikiwiki's user interface; do not normally need
+ to be customised.
[[!meta robots="noindex, follow"]]
diff --git a/doc/wikiicons/emaillogin.png b/doc/wikiicons/emaillogin.png
new file mode 100644
index 000000000..1b16befd6
--- /dev/null
+++ b/doc/wikiicons/emaillogin.png
Binary files differ