summaryrefslogtreecommitdiff
path: root/plugins/AutoSandbox/README
diff options
context:
space:
mode:
authorSean Carmody <sean@stubbornmule.net>2010-03-18 00:06:42 +1100
committerZach Copley <zach@status.net>2010-03-22 17:18:43 +0000
commitc810f2485132fe124e671dee4f86eb721eee15e4 (patch)
tree112ab409a29e2ea4cc4698b294162ef942794c02 /plugins/AutoSandbox/README
parent0a6b30552d16201e5a1999da6e7d3ab0f63852cd (diff)
Added plugin AutoSandbox for spam-management: new users sandboxed by default
Diffstat (limited to 'plugins/AutoSandbox/README')
-rw-r--r--plugins/AutoSandbox/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/plugins/AutoSandbox/README b/plugins/AutoSandbox/README
new file mode 100644
index 000000000..2f5d625f7
--- /dev/null
+++ b/plugins/AutoSandbox/README
@@ -0,0 +1,39 @@
+StatusNet AutoSandbox plugin 0.1 03/16/10
+=========================================
+Automatically sandboxes newly registered users as a spam-management technique.
+Only really suits small sites where all users can be hand-moderated. A moderator
+will then have to unbox legimate users, using the following built-in script:
+
+./scripts/userrole.php -n username -r moderator
+
+(replace 'username' with the nickname of the user you wish to make a moderator).
+
+The following note will be added to the top of the Registration form:
+
+"Note you will initially be "sandboxed" so your posts will not appear in the
+public timeline."
+
+This can be followed by the following extra information if a contact user (denoted
+here by XXX) is specified:
+
+"Send a message to @XXX to speed up the unsandboxing process."
+
+If no contact user is specified, it will default to the "Default subscription" user
+who automatically subscribes to new users (set in Admin -> User).
+
+Use:
+1. Add plugin:
+
+Default usage:
+addPlugin('AutoSandbox');
+
+Specify a contact user (replace 'someuser' with appropriate username):
+addPlugin('AutoSandbox', array('contact' => 'someuser'));
+
+Stop contact user from defaulting to the Defaul subscription:
+addPlugin('AutoSandbox', array('contact' => ''));
+
+Changelog
+=========
+0.1 initial release
+