README

POWER CAPTCHA protects your OXID eShop against bots and unauthorized persons. GDPR compliant!

This OXID eShop Module integrates POWER CAPTCHA into:

• Customer login forms
• Registration forms
• Checkout completion
• Contact form
• Password reset form
• Newsletter form
• Wished price form

Compatibility

Supported Versions

Compatible with OXID eShop 7.1.x and 6.5.x.

• Version 2.x (branch: oxid-7.1) of our module is compatible with OXID eShop 7.1.x .
• Version 1.x (branch: oxid-6.5) of our module is compatible with OXID eShop 6.5.x .

Supported Themes

• Fully compatible with the following themes:
  • OXID 6.5: Wave, Flow, Azure (including child themes)
  • OXID 7.1: APEX theme
• Easily integrable into other custom themes.

Installation and Configuration

1. Install the Module

To install the module, use composer.

For OXID 7.1:

cd <shopRoot>
composer require power-captcha/integration-oxid-eshop:^2.0.0

For OXID 6.5:

cd <shopRoot>
composer require power-captcha/integration-oxid-eshop:^1.0.0

2. Activate the Module

Once installed, activate the module through the admin panel or via command line.

Activation via Admin Panel

Log in into your OXID eShop admin panel and navigate to Extensions ⇨ Modules. Select the POWER CAPTCHA module and click the Activate button.

Activation via Command Line

You can also activate the module using the OXID eShop console. Run the following command from your shop root directory:

vendor/bin/oe-console oe:module:activate power_captcha

If you need to activate the module for a specific sub-shop, use the following command (replacing <shop-id> with the actual shop ID):

vendor/bin/oe-console oe:module:activate power_captcha --shop-id <shop-id>

3. Configure the Module

Log in into your OXID eShop admin panel and navigate to Extensions ⇨ Modules. Select the POWER CAPTCHA module and click the Settings tab.

General settings

Enter your API Key and Secret Key, both keys can be found in the customer area of POWER CAPTCHA. If don't have an API Key yet, you can choose a plan on power-captcha.com.

Other general settings are optional.

Protected sections / forms

Here you can select which sections / forms in your shop should be protected by POWER CAPTCHA.

On-premise settings

These settings are only relevant if you are running a self-hosted POWER CAPTCHA instance. If not, you can leave these fields blank.

Development

Installation for development

1. Clone the module to <shopRoot>/dev/power-captcha/integration-oxid-eshop:

   cd <shopRoot>
   git clone -b oxid-7.1 https://github.com/power-captcha/integration-oxid-eshop dev/power-captcha/integration-oxid-eshop

2. Add and require the module from the local path via Composer:

   cd <shopRoot>
   composer config repositories.power-captcha/integration-oxid-eshop path ./dev/power-captcha/integration-oxid-eshop
   composer require power-captcha/integration-oxid-eshop:@dev

3. Install and activate the module using the OXID eShop console:

   cd <shopRoot>
   vendor/bin/oe-console oe:module:install vendor/power-captcha/integration-oxid-eshop
   vendor/bin/oe-console oe:module:activate power_captcha

4. Activate the module:

   cd <shopRoot>
   bin/oe-console oe:module:activate power_captcha

Useful commands

• Reinstalling the module

  After making changes, it is necessary to reinstall the module for the changes to take effect:

  cd <shopRoot>
  vendor/bin/oe-console oe:module:install vendor/power-captcha/integration-oxid-eshop

• Reactivating the module

  If you make changes to services.yaml (e.g. adding more services) or metadata.php (e.g. extending new OXID eShop components), you may need to reactivate the module:

  cd <shopRoot>
  vendor/bin/oe-console oe:module:activate power_captcha

• Clearing the cache

  You can clear the cache with

  cd <shopRoot>
  vendor/bin/oe-console oe:cache:clear