Commits

Greg Salt committed fbac222

Updater

Comments (0)

Files changed (3)

    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Project Cerberus Documentation
-==============================
+Project Cerberus
+================
 
 Project Cerberus is a webservice that enables your ExpressionEngine sites to report member spam and then check member actions against a master database of known or suspected spammers.
 
 
 2. Download the addon you need
 
-   We provide a extension for EE 2.x that is triggered when you move a member into the banned group. There is also an extension that complements `Member Utilities 1.x <http://devot-ee.com/add-ons/member-utilities>`_. Unfortunately there is no standalone extension for ExpressionEngine 1.x.
+   We provide a extension for EE 2.x called :doc:`updater` that is triggered when you move a member into the banned group. There is also an extension that complements `Member Utilities 1.x <http://devot-ee.com/add-ons/member-utilities>`_. Unfortunately there is no standalone extension for ExpressionEngine 1.x.
 
 3. Use your site as normal
 

docs/registration.rst

-.. _registration-details:
-
 Account Registration
 ====================
 
+Cerberus Updater
+================
+
+Updating is the process of sending sending spam members to our network so that your site and other ExpressionEngine sites can query that data.
+
+.. attention::
+
+    Don’t forget that you must have `registered`_ any sites that you wish to install Cerberus Updater on
+
+ExpressionEngine 2.x
+--------------------
+
+For EE 2.x users there is a simple extension that doens't add any new functionality to the member management tools with EE but if a member is banned then it will seamlessly also update the Cerberus database with that member data.
+
+Installation
+------------
+
+Copy the ``cerberus_updater`` folder into your ``system/expressionengine/third_party`` folder and then enable the extension in your EE control panel.
+
+Configuration
+-------------
+
+There are 4 configuration settings for the extension:
+
+Enable Cerberus Updater for this site?
+    You can turn Cerberus Updater on or off without losing your settings
+
+Empty member profile when banned?
+    You can choose to have the member URL, biography and signature fields emptied when moving a member into the banned group.
+
+Added banned member details to ban lists?
+    This setting automatically populates the standard EE member ban lists with the banned member username, email and IP address.
+
+    .. attention::
+        
+        Be careful with this setting. It is off by default and unless you **really** need this we recommend keeping this off. The reason is that these lists will soon get very big and it all has to be loaded from disk on each page load.
+
+Cerberus Updater access key
+    The access key that you generated for your site. This is used to encrypt the data that is sent to the Cerberus database and it is tied to your site hostname.
+
+ExpressionEngine 1.x
+--------------------
+
+If you are a `Member Utilities <http://devot-ee.com/add-ons/member-utilities>`_ user then you can add an extension that hooks into the Member Utilities member banning process. The configuration for that extension is similar to the EE 2.x version.
+
+
+.. _`registered`: registration.html