wiki:TracCaptchaPlugin

TracCaptcha

Description

TracCaptcha is a trac plugin to embed a captcha in the ticket page in addition to Trac's regular permission checks so that spammers are kept out.

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 infrastructure.

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.

Generic Infrastructure: TracCaptcha takes care about embedding a given captcha in the appropriate places which means that building a different captcha plugin is easy - you just have to build the captcha itself while this code will take care of the trac integration.

The whole code is licensed under the very liberal MIT license so you can use the API in your own code without problems.

See it in Action

The macro is also used on the project page - but please keep in mind that this is not a online demo, so do not create tickets to test the captcha!

Download

The latest sources are available from the project page and pypi.

Configuration

Enable the macro in your trac.ini:

[components]
trac_captcha.* = enabled
# only needed if you want to use reCAPTCHA
trac_recaptcha.* = enabled

[recaptcha]
# add here the keys you got from http://recaptcha.net/api/getkey
public_key = ...
private_key = ...

If 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).

Dependencies and Compatibility

Bugs/Feature Requests

Existing bugs and feature requests for the TracCaptcha plugin are stored on the project page. Please do not file bugs in the trac-hacks bug tracker.

Author/Contributors

Author: felix_schwarz
Maintainer: felix_schwarz
Contributors:

Last modified 4 years ago Last modified on Mar 3, 2011, 9:23:36 PM

Attachments (1)

Download all attachments as: .zip