Edgewall Software

Changes between Version 49 and Version 50 of SpamFilter


Ignore:
Timestamp:
Dec 4, 2010, 11:02:27 PM (13 years ago)
Author:
Dirk Stöcker
Comment:

Cleanup, configuration is done using webinterface nowadays

Legend:

Unmodified
Added
Removed
Modified

  • SpamFilter

    v49 v50  
    22[[PageOutline(2-3)]]
    33
    4 This plugin allows different ways to reject contributions that contain spam. This plugin requires Trac release [milestone:0.11] or [milestone:0.12].
     4This plugin allows different ways to reject contributions that contain spam. This plugin requires Trac release [milestone:0.12]. The plugin code for versions before 0.12 aren't updated any more.
    55
    66The spamfilter plugin has many options, but most of them are optional. Basically installing is enough to have a basic spam protection. But there are some things which may be helpful (in order of importance):
    … …  
    88 * Setup !BadContent page containing regular expressions to filter
    99 * Get API keys for Akismet, !TypePad and/or HTTP:BL to use external services
    10  * Activate captcha rejection handler to improve user treatment
    11  * finetune the karma settings and parameters for your system (e.g. you may increase karma for good trained bayes filters or stop trusting registered users)
     10 * Activate captcha rejection handler to improve user treatment (may nee reCAPTCHA access when that method should be used)
     11 * Finetune the karma settings and parameters for your system (e.g. you may increase karma for good trained bayes filters or stop trusting registered users)
     12
     13
     14WebAdmin is used for configuration, monitoring, and training. For monitoring and training purposes, it optionally logs all activity to a table in the database. Upgrading the environment is necessary to install the database table required for this logging.
    1215
    1316== Supported Filtering Strategies ==
    … …  
    4043=== Akismet ===
    4144
    42 The [source:plugins/0.12/spam-filter-captcha/tracspamfilter/filters/akismet.py akismet] filter uses the [http://akismet.com/ Akismet] web service to check content for possible spam.
     45The [source:plugins/0.12/spam-filter-captcha/tracspamfilter/filters/akismet.py Akismet] filter uses the [http://akismet.com/ Akismet] web service to check content for possible spam.
    4346
    44 The use of this filter requires a [http://www.wordpress.com Wordpress] API key. The API key is configured in [wiki:TracIni trac.ini] in a separate section:
    45 
    46 {{{
    47 [spam-filter]
    48 akismet_api_key = 1234567890
    49 }}}
     47The use of this filter requires a [http://www.wordpress.com Wordpress] API key. The API key is configured in the 'External' administration page.
    5048
    5149=== !TypePad ===
    … …  
    5351The [source:plugins/0.12/spam-filter-captcha/tracspamfilter/filters/typepad.py TypePad AntiSpam] filter uses the [http://antispam.typepad.com/ Typepad] web service to check content for possible spam.
    5452
    55 The use of this filter requires a API key. The API key is configured in [wiki:TracIni trac.ini] in a separate section:
    56 
    57 {{{
    58 [spam-filter]
    59 typepad_api_key = 1234567890
    60 }}}
     53The use of this filter requires a API key. The API key is configured in the 'External' administration page.
    6154
    6255=== HTTP:BL ===
    … …  
    6457The [source:plugins/0.12/spam-filter-captcha/tracspamfilter/filters/httpbl.py HTTP:BL] filter uses the [http://www.projecthoneypot.org/httpbl.php Project HoneyPot HTTP:BL] web service to check content for possible spam.
    6558
    66 The use of this filter requires a [http://www.projecthoneypot.org/httpbl_configure.php HTTP:BL] API key. The API key is configured in [wiki:TracIni trac.ini] in a separate section:
    67 
    68 {{{
    69 [spam-filter]
    70 httpbl_api_key = abcdefghijkl
    71 }}}
     59The use of this filter requires a [http://www.projecthoneypot.org/httpbl_configure.php HTTP:BL] API key. The API key is configured in the 'External' administration page.
    7260
    7361=== Captcha ===
    7462
    75 Since version 0.3.1 the support to have CAPTCHA-style "human" verification has been integrated.
     63Support to have CAPTCHA-style "human" verification is integrated. Captcha usage is configured in the 'Captcha' administration page.
    7664
    77 Note that you need to add the following to your [TracIni trac.ini]:
    78 {{{
    79 [spam-filter]
    80 ...
    81 reject_handler = CaptchaSystem
    82 # captcha = ExpressionCaptcha
    83 # (default, doesn't need to be specified explicitly)
    84 # captcha = ImageCaptcha
    85 # (needs to be activated and needs PIL to be installed)
    86 # captcha = RecaptchaCaptcha
    87 # (uses Googles reCAPTCHA service)
    88 # captcha = RandomCaptcha
    89 # (chooses one of the others randomly)
    90 }}}
    91 To use RecaptchaCaptcha, you'll need to sign up at http://www.google.com/recaptcha/whyrecaptcha and set
    92 {{{
    93 captcha_recaptcha_public_key= ..
    94 captcha_recaptcha_private_key= ..
    95 }}}
     65To use reCAPTCHA captcha method, you'll need to sign up at [http://www.google.com/recaptcha/whyrecaptcha] and set the keys at 'Captcha' administration page.
    9666
    9767=== Bayes ===
    … …  
    10070
    10171> (The code in svn uses [http://spambayes.org SpamBayes], which is a logical choice.  It would make sense to use a custom tokenizer, however, rather than the email-centric one that is included with [http://spambayes.org SpamBayes].  The bigger issue is that some form of training is required (e.g. the API could be extended so that (optionally) authenticated users (and the other filters) could report contributions as spam (using automatic training to assume that everything else is ham); however, this is a complex change).  An alternative to this would be a script that could be periodically executed that would train all existing contributions as ham, and gather spam from an appropriate source.  If you decide to continue with this in the future, please don't hestiate to ask [mailto:spambayes-dev@python.org spambayes-dev] for help.
    102 
    103 == WebAdmin Integration ==
    104 
    105 The SpamFilter plugin provides integration with WebAdmin for configuration, monitoring, and training. For monitoring and training purposes, it optionally logs all activity to a table in the database. Upgrading the environment is necessary to install the database table required for this logging.
    10672
    10773== Get the Plugin ==
    … …  
    12389You can [source:plugins/0.12/spam-filter-captcha browse the source in Trac].
    12490
    125 Recommended versions:
    126 || Trac                  || Spam Filter ||
    127 || [milestone:0.11]      || latest (in 0.12 tree)||
    128 || [milestone:0.12]      || latest ||
    129 
    13091''[http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha/#egg=TracSpamFilter-dev This is a link for setuptools to find the SVN download]''
    13192
    13293== Enabling the Plugin ==
    13394
    134 If you install the plugin globally (as described [wiki:TracPlugins#ForAllProjects here]), you'll also need to enable it in [wiki:TracIni trac.ini] as follows:
     95If you install the plugin globally (as described [wiki:TracPlugins#ForAllProjects here]), you'll also need to enable it in the web administration or in [wiki:TracIni trac.ini] as follows:
    13596{{{
    13697[components]
    … …  
    153114 * '''Attention''': The 1.7 series of dnspython causes a massive slowdown of whole Trac. Use 1.6.x or 1.8.x.
    154115 * The !ImageCaptcha requires python-imaging to work.
    155 
    156 == Comments ==
     116 * Bayes filtering needs spambayes software installed.
    157117
    158118----