Changes between Version 5 and Version 6 of TracCaptchaPlugin
- Timestamp:
- Mar 12, 2015, 4:55:39 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracCaptchaPlugin
v5 v6 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = !TracCaptcha =3 = !TracCaptcha 4 4 5 == Description ==5 == Description 6 6 7 !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.7 This plugin embeds a captcha in the ticket page in addition to Trac's regular permission checks. Its purpose is to keep spammers out of the Trac environment. 8 8 9 '''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 10 infrastructure. 9 '''Fully functional:''' The popular reCAPTCHA system is supported out of the box. Technically it's a plugin: if you don't like it, you are free to use any other plugin while still leverage the benefits from the general captcha infrastructure. 11 10 12 11 '''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. 13 12 14 '''Generic Infrastructure:''' !TracCaptcha takes care about embedding a 15 given captcha in the appropriate places which means that building a different 16 captcha plugin is easy - you just have to build the captcha itself while this 17 code will take care of the trac integration. 13 '''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. 18 14 19 The 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.15 The 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. 20 16 21 == See it in Action == 17 == See it in Action 18 22 19 [[Image(wiki:TracCaptchaPlugin:captcha_example.png)]] 23 20 24 The macro is also used on the '''[http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]''' - but please keep in mind that this is not aonline demo, so do not create tickets to test the captcha!21 The macro is also used on the '''[http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]''', but please keep in mind that this is not an online demo, so do not create tickets to test the captcha! 25 22 26 == Download ==23 == Download 27 24 28 The latest sources are available from the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page] and [ http://pypi.python.org/pypi/TracCaptcha pypi].25 The latest sources are available from the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page] and [pypi:TracCaptcha]. 29 26 30 === Configuration === 31 Enable the macro in your trac.ini: 27 === Configuration 28 29 Enable the macro in your `trac.ini`: 32 30 {{{ 31 #!ini 33 32 [components] 34 33 trac_captcha.* = enabled … … 37 36 38 37 [recaptcha] 39 # add here the keys you gotfrom http://recaptcha.net/api/getkey38 # add here the keys you obtained from http://recaptcha.net/api/getkey 40 39 public_key = ... 41 40 private_key = ... 42 41 }}} 43 42 44 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).43 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. 45 44 46 === Dependencies and Compatibility === 45 === Dependencies and Compatibility 46 47 47 * Python 2.3-2.7 48 48 * [trac: Trac] 0.11, 0.12, 0.13 49 * ''optional'': [http://www.pycrypto.org PyCrypto] for better security on Python 2.3 and 2.449 * Optional: [http://www.pycrypto.org PyCrypto] for better security on Python 2.3 and 2.4 50 50 51 == Bugs/Feature Requests ==51 == Bugs/Feature Requests 52 52 53 53 Existing bugs and feature requests for the !TracCaptcha plugin are stored on the [http://www.schwarz.eu/opensource/projects/trac_captcha/ project page]. Please do not file bugs in the trac-hacks bug tracker. 54 54 55 56 == Author/Contributors == 55 == Author/Contributors 57 56 58 57 '''Author:''' [wiki:felix_schwarz] [[BR]] 59 '''Maintainer:''' [ wiki:felix_schwarz] [[BR]]58 '''Maintainer:''' [[Maintainer]] [[BR]] 60 59 '''Contributors:'''