Documentation

Once your CB AntiSpam plugin is installed and published you will be able configure it by visiting the plugin Parameters tab in the Community Builder Plugin Management area.
There you will see the following parameter tabs.

General (tab)

This tab has the following parameters:

• Template
  You can select template to be used for all of CB AntiSpam. If template is incomplete then missing files will be used from the default template. Template files can be located at the following location: components/com_comprofiler/plugin/user/plug_cbantispam/templates/.
• Class
  Optionally add a class suffix to surrounding DIV encasing all of CB AntiSpam.
• Block and/or Whitelist
  You can Enable or Disable usage of Blocking and/or Whitelisting.
  Disabling will prevent all queries and checks from functioning to free up system resources if needed.
• Attempts
  If enabled, it records failed of filling in the captcha.
  Disabling will prevent all queries and checks from functioning to free up system resources if needed.
  Note: disabling this will also disable auto blocking.
• Log
  If enabled, it records IP address of users who filled in the captcha.
  Disabling will prevent all queries and checks from functioning to free up system resources if needed.
  Note: disabling this will also disable the IP Address field.
  
  

For those enabled you can keep track of the relevant records from the buttons found under the name of CB AntiSpam, In plugin Manager.

Menu (tab)

From here you can enable or disable the following CB menu items that Moderators can use for easy blocking or whitelisting users, email address and Ips:

• Block user.
• Block IP address.
• Block email address.
• Block email domain.
• Whitelist user.
• Whitelist IP address.
• Whitelist email address
• Whitelist email domain

Login (tab)

This tab has 4 subtabs with parameter settings.

Blocked (sub-tab)

• Redirect URL:
  Input a URL to redirect the user to if login is blocked. If left blank by default will redirect to index.php.
• Redirect Message:
  Optionally input a message to include with the redirect.
• Redirect Type:
  Optionally input redirect message type (e.g. message, error, warning, alert, etc..).
  Only used if Redirect Message is used. Determines the style of the Redirect Message.

Duplicates (sub-tab)

• Block:
  Enable or disable blocking of duplicate logins.
  This checks if the number of active sessions for an account surpass a specified limit.

Sharing (sub-tab)

• Block:
  Enable or disable blocking of shared logins.
  This checks the number of unique IP Addresses that have been used to access an account surpass a specified limit.

Auto block (sub-tab)

• Block:
  Enable or disable blocking of IP Address after a number of failed login attempts.

Forgot Login (tab)

This tab has 2 sub-tabs with extra parameters.

Blocked (sub-tab)

• Redirect URL:
  Input a URL to redirect the user to if login is blocked. If left blank by default will redirect to index.php.
• Redirect Message:
  Optionally input a message to include with the redirect.
• Redirect Type:
  Optionally input redirect message type (e.g. message, error, warning, alert, etc..).
  Only used if Redirect Message is used. Determines the style of the Redirect Message.

Auto Block (sub-tab)

• Enable or disable blocking after a number of forgot login attempts.
  Blocked users will have all forgot login attempts force failed.

Registration (tab)

This tab has 3 sub-tabs with parameters.

Blocked (sub-tab)

Same settings as at Forgot Login – Blocked, but for registration process

Duplicates (sub-tab)

• Enable or disable blocking of duplicate registrations.
  This checks if the number of accounts for the IP Address surpass a specified limit.

Auto block (sub-tab)

• Enable or disable blocking of IP Address after a number of failed registration attempts.

Captcha (tab)

General (sub-tab)

• Mode
  You can choose the mode of captcha. Internal modes do not require Site Key and Secret Key
• Preview
  Expected captcha image output. Note audio is not supported in preview for Internal modes.
• Honeypot
  Enable or disable usage of hidden honeypot input. This input is not displayed, but if completed will fail validation. This is useful to stop spam bots auto-filling forms.
• Honeypot Name
  Optionally give a honeypot input name. Change only if conflicts with an input used in your forms.

Legacy (sub-tab)

• Enable or disable captcha at Forgot Login, Email From, Login

Modes (sub-tab)

This sub-tab also has more tabs in it:

• Internal
  You can adjust the display of captcha over: Format, enabling or disabling Audio and Refresh, mage height, color, background, rotation, length, character set etc.

If you use Internal Question you can apply your own questions.

Note that internal mode is responsive.

• reCaptcha
  You can use Google style. Note that it may be not responsive and you should add some css code yourself.

In order to use Google reCaptcha you need Site Key and Secret Key.

To get those keys

• Go to https://www.google.com/recaptcha/admin#list
• Login to your gmail account
• On the top right click on “Get reCaptcha”
• Register your website
• Copy your keys and paste them in the proper fields.

Cleanup (tab)

Get your site’s unique URL that can be used in CRON or directly accessed to prune expired blocks, old log entries, and old attempts entries.
You can select how long to keep log entries and long to keep attempts entries.

Tip
CB Moderators are exempt from Captcha. For that reason "Moderator View Access Level" should strictly set (e.g. Special).

In plugin Manager under the name of CB AntiSpam there are 4 buttons from which you can keep track of the relevant records, if the corresponding fields in General tab are enabled.

• Blocks 
• Whitelists 
• Attempts 
• Logs