You are here

README.txt in reCAPTCHA 5.2

reCAPTCHA for Drupal
====================

The reCAPTCHA module uses the reCAPTCHA web service to
improve the CAPTCHA system and protect email addresses. For
more information on what reCAPTCHA is, please visit:
    http://recaptcha.net


INSTALLATION
------------

1. Extract the reCAPTCHA module to your local favourite
   modules directory (sites/all/modules).

2. Enable reCAPTCHA and CAPTCHA modules in:
       admin/build/modules


CONFIGURATION
-------------

1. You'll now find a reCAPTCHA tab in the CAPTCHA
   administration page available at:
       admin/user/captcha/recaptcha

2. Register for a public and private reCAPTCHA key at:
       http://recaptcha.net/api/getkey

3. Input the keys into the reCAPTCHA settings. The rest of
   the settings should be fine as their defaults.

4. Visit the Captcha administration page and set where you
   want the reCAPTCHA form to be presented:
       admin/user/captcha


MAILHIDE INPUT FORMAT
---------------------

The reCAPTCHA module also comes with an input format to
protect email addresses. This, of course, is optional to
use and is only there if you want it. The following is how
you use that input filter:

1. Enable the reCAPTCHA Mailhide module:
       admin/build/modules

2. Head over to your input format settings:
       admin/settings/filters

3. Edit your default input format and add the reCAPTCHA
   Mailhide filter.
   
4. Click on the Configure tab and put in a public and
   private Mailhide key obtained from:
       http://mailhide.recaptcha.net/apikey

5. Use the Rearrange tab to rearrange the weight of the
   filter depending on what filters already exist.  Make
   sure it is before the URL Filter.

Note: You will require the installation of the mcrypt
      PHP module in your web server for Mailhide to work:
         http://uk2.php.net/manual/en/ref.mcrypt.php


MULTI-DOMAIN SUPPORT
--------------------

Since reCAPTCHA uses API keys that are unique to each
domain, if you're using a multi-domain system using the
same database, the reCAPTCHA module won't work when
querying the reCAPTCHA web service.  If you put the
following into your sites/mysite/settings.php file for
each domain, it will override the API key values and make
it so multi-domain systems are capable.

  $conf = array(
    'recaptcha_public_key' =>  'my other public key',
    'recaptcha_private_key' =>  'my other private key',
  );


CUSTOM RECAPTCHA THEME
----------------------

You can create a custom reCAPTCHA theme widget by setting
the theme of the reCAPTCHA form to "custom" in the
reCAPTCHA administration page.  This will output a custom
form that is themeable through the theme function:
  theme_recaptcha_custom_widget().
  
If you don't implement this function, it is still quite
easily customizable through manipulating the CSS.

For more information on this, visit:
http://recaptcha.net/apidocs/captcha/client.html#customization


CHANGELOG
---------

http://drupal.org/project/cvs/147903?branch=DRUPAL-5--2


THANK YOU
---------

 * Thank you goes to the reCAPTCHA team for all their
   help, support and their amazing Captcha solution
       http://www.recaptcha.net

File

README.txt
View source
  1. reCAPTCHA for Drupal
  2. ====================
  3. The reCAPTCHA module uses the reCAPTCHA web service to
  4. improve the CAPTCHA system and protect email addresses. For
  5. more information on what reCAPTCHA is, please visit:
  6. http://recaptcha.net
  7. INSTALLATION
  8. ------------
  9. 1. Extract the reCAPTCHA module to your local favourite
  10. modules directory (sites/all/modules).
  11. 2. Enable reCAPTCHA and CAPTCHA modules in:
  12. admin/build/modules
  13. CONFIGURATION
  14. -------------
  15. 1. You'll now find a reCAPTCHA tab in the CAPTCHA
  16. administration page available at:
  17. admin/user/captcha/recaptcha
  18. 2. Register for a public and private reCAPTCHA key at:
  19. http://recaptcha.net/api/getkey
  20. 3. Input the keys into the reCAPTCHA settings. The rest of
  21. the settings should be fine as their defaults.
  22. 4. Visit the Captcha administration page and set where you
  23. want the reCAPTCHA form to be presented:
  24. admin/user/captcha
  25. MAILHIDE INPUT FORMAT
  26. ---------------------
  27. The reCAPTCHA module also comes with an input format to
  28. protect email addresses. This, of course, is optional to
  29. use and is only there if you want it. The following is how
  30. you use that input filter:
  31. 1. Enable the reCAPTCHA Mailhide module:
  32. admin/build/modules
  33. 2. Head over to your input format settings:
  34. admin/settings/filters
  35. 3. Edit your default input format and add the reCAPTCHA
  36. Mailhide filter.
  37. 4. Click on the Configure tab and put in a public and
  38. private Mailhide key obtained from:
  39. http://mailhide.recaptcha.net/apikey
  40. 5. Use the Rearrange tab to rearrange the weight of the
  41. filter depending on what filters already exist. Make
  42. sure it is before the URL Filter.
  43. Note: You will require the installation of the mcrypt
  44. PHP module in your web server for Mailhide to work:
  45. http://uk2.php.net/manual/en/ref.mcrypt.php
  46. MULTI-DOMAIN SUPPORT
  47. --------------------
  48. Since reCAPTCHA uses API keys that are unique to each
  49. domain, if you're using a multi-domain system using the
  50. same database, the reCAPTCHA module won't work when
  51. querying the reCAPTCHA web service. If you put the
  52. following into your sites/mysite/settings.php file for
  53. each domain, it will override the API key values and make
  54. it so multi-domain systems are capable.
  55. $conf = array(
  56. 'recaptcha_public_key' => 'my other public key',
  57. 'recaptcha_private_key' => 'my other private key',
  58. );
  59. CUSTOM RECAPTCHA THEME
  60. ----------------------
  61. You can create a custom reCAPTCHA theme widget by setting
  62. the theme of the reCAPTCHA form to "custom" in the
  63. reCAPTCHA administration page. This will output a custom
  64. form that is themeable through the theme function:
  65. theme_recaptcha_custom_widget().
  66. If you don't implement this function, it is still quite
  67. easily customizable through manipulating the CSS.
  68. For more information on this, visit:
  69. http://recaptcha.net/apidocs/captcha/client.html#customization
  70. CHANGELOG
  71. ---------
  72. http://drupal.org/project/cvs/147903?branch=DRUPAL-5--2
  73. THANK YOU
  74. ---------
  75. * Thank you goes to the reCAPTCHA team for all their
  76. help, support and their amazing Captcha solution
  77. http://www.recaptcha.net