Captcha

For documentation, see https://github.com/praekelt/django-recaptcha

Sign up to reCAPTCHA on https://www.google.com/recaptcha/admin.

You will receive a site key and a secret key…

Tip

If you want to use the Captcha on your laptop from http://localhost:8000/, then add localhost to the list of domains.

In the salt sls file for your site, add the norecaptcha_site_key and the norecaptcha_secret_key e.g:

norecaptcha_site_key: <your site key>
norecaptcha_secret_key: <your secret key>

Note

Replace <your site key> and <your secret key> with the actual reCAPTCHA keys.

Add the following to requirements/base.txt:

django-recaptcha

Add the following to settings/base.py:

THIRD_PARTY_APPS = (
    'captcha',
    # ...
)

Add the following to settings/production.py:

# https://github.com/praekelt/django-recaptcha
RECAPTCHA_PRIVATE_KEY = get_env_variable('NORECAPTCHA_SECRET_KEY')
RECAPTCHA_PUBLIC_KEY = get_env_variable('NORECAPTCHA_SITE_KEY')

Tip

For testing, do not set RECAPTCHA_PRIVATE_KEY or RECAPTCHA_PUBLIC_KEY. Google provides test keys which are set as the default.

When setting up your project for local development, you will need to set-up the environment variables as follows (can be added to .private):

export NORECAPTCHA_SITE_KEY="<your site key>"
export NORECAPTCHA_SECRET_KEY="<your secret key>"

Note

Replace <your site key> and <your secret key> with the actual reCAPTCHA keys.

To add a captcha field to your form:

from captcha.fields import ReCaptchaField

class EnquiryForm(RequiredFieldForm):
    captcha = ReCaptchaField()

Testing

Add the following to your local settings file e.g. settings/dev_patrick.py:

SILENCED_SYSTEM_CHECKS = ["captcha.recaptcha_test_key_error"]

From Django reCAPTCHA, Unit Testing:

data = {
    "name": "Patrick",
    "g-recaptcha-response": "PASSED",
}
response = client.post(reverse("example.enquiry.create"), data)

Note

No need to use os.environ["RECAPTCHA_TESTING"] = "True" in tests any more!

Note

g-recaptcha-response has replaced recaptcha_response_field.

Note

For testing, do not set RECAPTCHA_PRIVATE_KEY or RECAPTCHA_PUBLIC_KEY. Google provides test keys which are set as the default.