# HG changeset patch
# User MWild1@gmail.com
# Date 1370530912 0
# Node ID f90471dee368c9d7c3ae4ea6d49b4363f475b81d
# Parent  3f94f7728cb448b17e8a607eb3b7748bc66620b8
Created wiki page through web user interface.

diff -r 3f94f7728cb4 -r f90471dee368 mod_block_registrations.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_block_registrations.wiki	Thu Jun 06 15:01:52 2013 +0000
@@ -0,0 +1,39 @@
+#summary Prevent registration of user accounts according to policies
+#labels Stage-Beta
+
+= Introduction =
+
+On a server with public registration it is usually desirable to prevent registration of certain "reserved" accounts, such as "admin".
+
+This plugin allows you to reserve individual usernames, or those matching certain patterns. It also allows you to ensure that usernames conform to a certain pattern.
+
+= Configuration =
+
+Enable the module as any other:
+
+{{{
+    modules_enabled = {
+        "block_registrations";
+    }
+}}}
+
+You can then set some options to configure your desired policy:
+
+|| *Option* || *Default* || *Description* ||
+|| block_registrations_users || { "admin" } || A list of reserved usernames ||
+|| block_registrations_patterns || { } || A list of patterns matching reserved usernames (slower than block_registrations_users) ||
+|| block_registrations_allow || nil || A pattern that registered user accounts MUST match to be allowed ||
+
+Some examples:
+
+{{{
+    block_registrations_users = { "admin", "root", "xmpp" }
+    block_registrations_patterns = {
+        "master$" -- matches postmaster, hostmaster, webmaster, etc.
+    }
+    block_registrations_allow = "^[a-zA-Z0-9_-.]$" -- Allow only simple ASCII characters in usernames
+}}}
+
+= Compatibility =
+|| 0.9 || Works ||
+|| 0.8 || Should work ||
\ No newline at end of file