To install this module, place it in your sites/all/modules folder and enable it on the modules page.
All settings for this module are on the Honeypot configuration page, under the Configuration section, in the Content authoring settings. You can visit the configuration page directly at admin/config/content/honeypot.
Note that, when testing Honeypot on your website, make sure you're not logged in as an administrative user or user 1; Honeypot allows administrative users to bypass Honeypot protection, so by default, Honeypot will not be added to forms accessed by site administrators.
If you want to add honeypot to your own forms, or to any form through your own module's hook_form_alter's, you can simply place the following function call inside your form builder function (or inside a hook_form_alter):
honeypot_add_form_protection(
$form,
$form_state,
array('honeypot', 'time_restriction')
);
Note that you can enable or disable either the honeypot field, or the time restriction on the form by including or not including the option in the array.
Honeypot includes a docker-compose.yml
file that can be used for testing purposes. To build a Drupal 8 environment for local testing, do the following:
/etc/hosts
file: 192.168.22.33 local.drupalhoneypot.com
docker-compose up -d
in this directory.docker exec honeypot install-drupal 7.x
(optionally provide a version after install-drupal
).docker exec honeypot ln -s /opt/honeypot/ /var/www/drupalvm/drupal/web/sites/all/modules/honeypot
http://local.drupalhoneypot.com/user
and log in using the admin credentials Drush displayed.Note: If you're using a Mac, you may also need to perform additional steps to get the hostname working; see Managing your hosts file in the Drupal VM documentation.
The Honeypot module was originally developed by Jeff Geerling of Midwestern Mac, LLC (midwesternmac.com), and sponsored by Flocknote (flocknote.com).