[[PageOutline(2-5,Contents,pullout)]]

= Simple CAPTCHA for new user registration

== Description

This plugin implements a simple [wikipedia:CAPTCHA Captcha] for new user registration using Trac's AccountManagerPlugin that uses [http://skimpygimpy.sourceforge.net/ Skimpy Gimpy] challenges:

[[Image(captcha.png, border=2)]]

The plugin requires that AccountManagerPlugin has been patched to include an `IRegistrationConfirmation` extension point by the RegistrationConfirmationPatch.

An unmaintained version of this plugin that does not require modification to AccountManagerPlugin is [https://svn.openplans.org/svn/trac/CaptchaAuth/ available here].

Note that skimpyGimpy itself is BSD-licensed. 

See also: CaptchaAuthPlugin, CaptchaAuthPlusPlugin, both of which also implement skimpyGimpy.

== Bugs/Feature Requests

Existing bugs and feature requests for SimpleCaptchaPlugin are 
[report:9?COMPONENT=SimpleCaptchaPlugin here].

If you have any issues, create a 
[/newticket?component=SimpleCaptchaPlugin new ticket].

[[TicketQuery(component=SimpleCaptchaPlugin&group=type,format=progress)]]

=== Known Issues

This plugin does not work with the Safari browser, because it uses [http://skimpygimpy.sourceforge.net/ Skimpy Gimpy]'s pre-formatted text Captcha, which does not render properly.

== Download

Download the zipped source from [export:simplecaptchaplugin here].

== Source

You can check out SimpleCaptchaPlugin from [/svn/simplecaptchaplugin here] using Subversion, or [source:simplecaptchaplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

To use you SimpleCaptchaPlugin you should:

 1. Have patched AccountManagerPlugin to provide the IRegistrationConfirmation extension point using the RegistrationConfirmationPatch.
 1. Add the following to your `trac.ini` file:

 {{{#!ini
[simplecaptcha]
dictionary_file = /path/to/dictionary.txt
}}}

 where /path/to/dictionary.txt is the path to the text file used to generate the words for the CAPTCHAs. If you do not provide your own dictionary file, the plugin will download [[http://java.sun.com/docs/books/tutorial/collections/interfaces/examples/dictionary.txt Sun's default dictionary file] on startup.

'''Note''': The words that skimpyGimpy generates must consist of at least 5 characters, otherwise they are not accepted!

== Recent Changes

[[ChangeLog(simplecaptchaplugin, 3)]]

== Author/Contributors

''Originally developed at [http://openplans.org The Open Planning Project]''

'''Author:''' [wiki:nicholasbs] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' [wiki:k0s]