aboutsummaryrefslogtreecommitdiff
path: root/doc/banned_users.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/banned_users.mdwn')
-rw-r--r--doc/banned_users.mdwn10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/banned_users.mdwn b/doc/banned_users.mdwn
new file mode 100644
index 000000000..c44f8c587
--- /dev/null
+++ b/doc/banned_users.mdwn
@@ -0,0 +1,10 @@
+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.