Changes between Initial Version and Version 1 of TracCaptchaPlugin


Ignore:
Timestamp:
Jun 25, 2010, 8:01:06 PM (11 years ago)
Author:
Felix Schwarz
Comment:

New hack TracCaptchaPlugin, created by felix_schwarz

Legend:

Unmodified
Added
Removed
Modified
  • TracCaptchaPlugin

    v1 v1  
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= TracCaptcha =
     4
     5== Description ==
     6
     7TracCaptcha is a trac plugin to embed a captcha in the ticket page in addition
     8to Trac's regular permission checks so that spammers are kept out.
     9
     10'''Batteries included:''' The popular reCAPTCHA system is supported out of the box. Technically it's a plugin - if you don't like it you're free to use any other plugin while still leverage the benefits from the general captcha
     11infrastructure.
     12
     13'''Does not annoy users:''' After the user entered the captcha once, he does not have to solve the captcha again for the same ticket when he just clicks 'preview'. Also you can configure exempt certain users or groups (e.g. 'all authenticated users') from the captchas just by using Trac's permission system.
     14
     15'''Generic Infrastructure:''' TracCaptcha takes care about embedding a
     16given captcha in the appropriate places which means that building a different
     17captcha plugin is easy - you just have to build the captcha itself while this
     18code will take care of the trac integration.
     19
     20The whole code is licensed under the very liberal [http://en.wikipedia.org/wiki/MIT_License MIT license] so you can use the API in your own code without problems.
     21
     22
     23
     24== Bugs/Feature Requests ==
     25
     26Existing bugs and feature requests for TracCaptchaPlugin are
     27[report:9?COMPONENT=TracCaptchaPlugin here].
     28
     29If you have any issues, create a
     30[http://trac-hacks.org/newticket?component=TracCaptchaPlugin&owner=felix_schwarz new ticket].
     31
     32== Download ==
     33
     34Download the zipped source from [download:traccaptchaplugin here].
     35
     36== Source ==
     37
     38You can check out TracCaptchaPlugin from [http://trac-hacks.org/svn/traccaptchaplugin here] using Subversion, or [source:traccaptchaplugin browse the source] with Trac.
     39
     40== Example ==
     41
     42=== Configuration ===
     43Enable the macro in your trac.ini:
     44{{{
     45[components]
     46trac_captcha.* = enabled
     47# only needed if you want to use reCAPTCHA
     48trac_recaptcha.* = enabled
     49
     50[recaptcha]
     51# add here the keys you got from http://recaptcha.net/api/getkey
     52public_key = ...
     53private_key = ...
     54}}}
     55
     56If you want to exempt some users from the captcha, grant them the CAPTCHA_SKIP privilege. TICKET_ADMINs and TRAC_ADMINs automatically have this privilege so they will never see a captcha. Also a user only needs to solve the captcha once per modification (so you can click 'preview' as often as you like without having to solve the captcha all over again).
     57
     58=== Dependencies and Compatibility ===
     59 * Python 2.3-2.6
     60 * [trac: trac] 0.11 or 0.12
     61 * ''optional'': [http://www.pycrypto.org PyCrypto] for better security on Python 2.3 and 2.4
     62
     63
     64== Recent Changes ==
     65
     66[[ChangeLog(traccaptchaplugin, 3)]]
     67
     68== Author/Contributors ==
     69
     70'''Author:''' [wiki:felix_schwarz] [[BR]]
     71'''Maintainer:''' [wiki:felix_schwarz] [[BR]]
     72'''Contributors:'''