(no commit message)

[git.ikiwiki.info.git] / doc / banned_users.mdwn

diff --git a/doc/banned_users.mdwn b/doc/banned_users.mdwn
index d2bec90f0459d9016461293bb4c68fa8849f078c..23433b15b3426c08e030e072dc8163add7d2afde 100644 (file)
--- a/doc/banned_users.mdwn
+++ b/doc/banned_users.mdwn
@@ -1,4 +1,14 @@
-Banned users can be configured in the setup file.
+Banned users can be configured in the setup file via the `banned_users`
+setting. This is a list of user names, or [[PageSpecs|ikiwiki/PageSpec]]
+to ban. Using a PageSpec is useful to block an IP address.
+
+For example:
+
+       banned_users => ['evilspammer', 'ip(192.168.1.1)'],

 
 If a banned user attempts to use the ikiwiki CGI, they will receive a 403
 Forbidden webpage indicating they are banned.
 
 If a banned user attempts to use the ikiwiki CGI, they will receive a 403
 Forbidden webpage indicating they are banned.

+
+Note that when [[plugins/emailauth]] is used, the user's email address
+is displayed in cloaked form in commits of their edits. This cloaked email
+address can be used as-is in the `banned_users` setting.