Extension reCAPTCHA


Extension Basics

Title
reCAPTCHA
Name
ckanext-recaptcha
Type
Public extension
Description
Google reCAPTCHA integration for CKAN forms
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-10-17
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

The recaptcha extension integrates Google reCAPTCHA protection into CKAN forms to prevent spam and automated bot submissions. It provides CAPTCHA verification for user registration, login, contact forms, and other public-facing forms in CKAN. The extension helps protect CKAN portals from automated abuse while maintaining a good user experience with Google’s reCAPTCHA service. Configuration would typically include reCAPTCHA site key and secret key from Google reCAPTCHA admin console.

Version
0.1.0.post1
Version release date
2024-10-17
Contact name
DataShades
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Requirements: - Google reCAPTCHA account and API keys

Installation: 1. Activate CKAN virtualenv 2. Clone and install: git clone https://github.com/DataShades/ckanext-recaptcha.git cd ckanext-recaptcha pip install -e . pip install -r requirements.txt

Add to ckan.plugins: recaptcha

Configuration: (Note: Specific config settings to be documented)

Google reCAPTCHA site key (public key)

ckanext.recaptcha.site_key = YOUR_SITE_KEY

Google reCAPTCHA secret key (private key)

ckanext.recaptcha.secret_key = YOUR_SECRET_KEY

reCAPTCHA version (v2 or v3)

ckanext.recaptcha.version = v2

Setup: 1. Register site at https://www.google.com/recaptcha/admin 2. Select reCAPTCHA type (v2 Checkbox, v2 Invisible, or v3) 3. Add your domain(s) 4. Copy site key and secret key to CKAN config 5. Restart CKAN

Features: - CAPTCHA protection for public forms - Prevents automated bot submissions - Protects user registration - Protects login forms - Protects contact/feedback forms - Google reCAPTCHA integration

Development: git clone https://github.com/DataShades/ckanext-recaptcha.git cd ckanext-recaptcha python setup.py develop pip install -r dev-requirements.txt

Testing: pytest –ckan-ini=test.ini

Plugins to configure (ckan.ini)
recaptcha
CKAN Settings (ckan.ini)
# ckanext.recaptcha.site_key = YOUR_SITE_KEY # ckanext.recaptcha.secret_key = YOUR_SECRET_KEY # ckanext.recaptcha.version = v2
DB migration to be executed
(not set)
<< back to Extensions