You are here

README.txt in reCAPTCHA 6

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:
    https://www.google.com/recaptcha


DEPENDENCIES
------------

* reCAPTCHA depends on the CAPTCHA module.
  https://drupal.org/project/captcha
* Some people have found that they also need to use jQuery Update module.
  https://drupal.org/project/jquery_update


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

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

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

3. Register for a public and private reCAPTCHA key at:
       https://www.google.com/recaptcha/admin/create

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

5. 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 text 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:
       https://www.google.com/recaptcha/mailhide/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://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:
https://developers.google.com/recaptcha/docs/customization


THANK YOU
---------

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

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