README.md 2.86 KB
Newer Older
1
2
3
4
5
6
7
8
9
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Conflicts/Known issues
 * Installation
 * Configuration
 * Maintainers
10

m1r1k's avatar
m1r1k committed
11

12
INTRODUCTION
13
------------
Arnab Nandi's avatar
Arnab Nandi committed
14

15
16
17
18
19
A CAPTCHA is a challenge-response test most often placed within web forms to
determine whether the user is human. The purpose of CAPTCHA is to block form
submissions by spambots, which are automated scripts that post spam content
everywhere they can. The CAPTCHA module provides this feature to virtually any
user facing web form on a Drupal site.
20

21
22
23
24
25
 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/captcha

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/captcha
26

27

28
29
REQUIREMENTS
------------
30
31
32

This module requires no modules outside of Drupal core.

33

34
35
CONFLICTS/KNOWN ISSUES
----------------------
36

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
CAPTCHA and page caching do not work together currently. However, the CAPTCHA
module does support the Drupal core page caching mechanism: it just disables the
caching of the pages where it has to put its challenges.

If you use other caching mechanisms, it is possible that CAPTCHA's won't work,
and you get error messages like 'CAPTCHA validation error: unknown CAPTCHA
session ID'.



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

 * Install the CAPTCHA module as you would normally install a contributed
   Drupal module. Visit https://www.drupal.org/node/1897420 for further
   information.

The configuration page is at admin/config/people/captcha,
55
56
  where you can configure the CAPTCHA module
  and enable challenges for the desired forms.
soxofaan's avatar
soxofaan committed
57
  You can also tweak the image CAPTCHA to your liking.
58

59
60
61
62
63
64
65
66
67
68
69
70
71
72
CONFIGURATION
-------------

    1. Navigate to Administration > Extend and enable the module.
    2. Navigate to Administration > Configuration > People > Captcha module
       settings to administer how and when Captcha is used.
    3. Select the challenge type you want for each of the listed forms.
    4. Select " Add a description to the CAPTCHA" to add a configurable
       description to explain the purpose of the CAPTCHA to the visitor.
    5. For Default CAPTCHA validation, define how the response should be
       processed by default. Note that the modules that provide the actual
       challenges can override or ignore this.
    6. Save configuration.

73
74
75

MAINTAINERS
-----------
76

77
78
79
80
81
   * Fabiano Sant'Ana (wundo) - https://www.drupal.org/u/wundo
   * Andrii Podanenko (podarok) - https://www.drupal.org/u/podarok
   * soxofaan - https://www.drupal.org/u/soxofaan
   * Lachlan Ennis (elachlan) - https://www.drupal.org/u/elachlan
   * Rob Loach (RobLoach) - https://www.drupal.org/u/robloach
82
83
84
85

Supporting organizations:

 * Chuva Inc. - https://www.drupal.org/chuva-inc
86
87
88
89
90
91

DEVELOPMENT
-------------
  You can disable captcha in your local or test environment by adding the
  following line to settings.php:
  $settings['disable_captcha'] = TRUE;