README

Overview

The Hyvä Captcha module enhances your Magento 2 store's security by adding a CAPTCHA solution to prevent bots from interacting with your website. It integrates seamlessly with the Hyvä theme and provides a user-friendly interface for configuration and management from the admin panel.

This module allows you to enable or disable CAPTCHA functionality through the backend, making it easy for store administrators to prevent unauthorized access and actions on your website. With support for image rotation and dynamic interaction, the CAPTCHA can be a powerful tool in improving your site's security.

Key Features

• Easy-to-use CAPTCHA for forms across the site.
• Supports image rotation for additional security.
• Fully configurable from the Magento admin panel.
• Seamless integration with the Hyvä theme.
• Toggle CAPTCHA functionality using Magento’s backend settings.

Module Requirements

• Magento 2.4.x or above.
• mhinspeya/backend-mod module: ^1.0

Long Description

The Hyvä Captcha module was developed to enhance the security of your Magento store by preventing bots from submitting forms and interacting with the store. This is particularly useful for protecting login, contact, and registration forms. The module integrates with the Hyvä theme, ensuring that the CAPTCHA is styled appropriately and does not break the frontend layout.

Configuration

• The module can be configured via the Magento admin panel under the "Hyvä Captcha Settings" tab.
• Admins can enable or disable the CAPTCHA from the backend and choose whether to show it on the storefront.

Benefits

• Security: Provides an extra layer of security by ensuring that only real users can interact with forms.
• Ease of Use: Simple and intuitive configuration, no coding required.
• Customization: Adjustable options for rotating images and CAPTCHA settings to suit your store’s needs.

Installation

Composer Installation (Preferred)

1. Install the module using Composer:

   Run the following command in your Magento 2 root directory:

   `composer require mhinspeya/captcha`

2. Run Magento Upgrade:

   After installation, update Magento to reflect the new module:

   `php bin/magento setup:upgrade`

3. Flush Cache:

   Clear the cache to make sure all new configurations are applied:

   `php bin/magento cache:flush`

4. Deploy Static Content (Optional):

   If you’re in production mode, you might need to deploy static content:

   `php bin/magento setup:static-content:deploy`

Manual Installation

1. Download and Extract the Module:

   Clone or download the repository from the internal Git repository: Git Modehaus Extract the files into `app/code/MHinspeya/Captcha.`

2. Enable the Module:

   Run the following command in your Magento root directory:

   `php bin/magento module:enable MHinspeya_Captcha`

3. Run Magento Setup Upgrade:

   Update Magento with the newly added module:

   `php bin/magento setup:upgrade`

4. Flush Cache:

   Clear Magento cache:

   `php bin/magento cache:flush`

5. Deploy Static Content (Optional):

   If you’re in production mode, deploy static content:

   `php bin/magento setup:static-content:deploy`

Configuration

1. After installation, go to the Magento Admin Panel.

2. Navigate to `Stores > Configuration > Hyvä Captcha Settings` to configure the module.

3. Enable or disable the CAPTCHA by setting the Enable Captcha option to Yes.

4. Adjust any other settings as needed, including display options and messages.

Troubleshooting

1. Ensure that the Hyvä theme is active on your store for full compatibility.

2. If the CAPTCHA is not showing on the frontend, verify that it’s enabled in the backend settings under `Stores > Configuration > Hyvä Captcha Settings.`

Uninstallation

1. To uninstall this module:

   Run the following command to disable the module:

   `php bin/magento module:disable MHinspeya_Captcha`

2. Remove the module files from your server `(app/code/MHinspeya/Captcha)`.

3. Run the following commands to clean up and update the Magento setup:

   `php bin/magento setup:upgrade`

   `php bin/magento cache:flush`

   `php bin/magento setup:static-content:deploy`