ALTCHA Spam Protection: Installation

Installing the ALTCHA Spam Protection module for OXID eShop 7 via Composer or manually, activation, update and uninstallation including the two database tables.

Deutsche Version

Back to overview

ALTCHA Spam Protection: Installation

Live Demo: Try this and other plugins live — no installation, no risk: demo.markus-michalski.net

Requirements

Requirement	Version
OXID eShop	`oxid-esales/oxideshop-ce` ^7.0
PHP	8.2 or higher
Database	MySQL or MariaDB (the checks use `ON DUPLICATE KEY` and `DATE_SUB`)

Installation

Via Composer (recommended)

Private repositories are managed through Packeton. You receive the credentials after purchasing a license.

1. Add the private repository:

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://packeton.markus-michalski.net"
        }
    ]
}

2. Install the module:

composer require mmd/oxid7-altcha-integration

When prompted for authentication, enter the credentials you received with your license. The Composer package places the module in the directory mmd/altcha-integration under source/modules.

3. Register and activate the module:

vendor/bin/oe-console oe:module:install-configuration source/modules/mmd/altcha-integration
vendor/bin/oe-console oe:module:activate mmd_altcha
vendor/bin/oe-console oe:cache:clear

Manual

Copy the module to source/modules/mmd/altcha-integration:

cd <shop-root>
git clone <repository-url> source/modules/mmd/altcha-integration

The module ships a PSR-4 autoload definition (Mmd\AltchaIntegration\ mapped to src/). For the Composer autoloader to know it, add the directory as a path repository:

composer config repositories.mmd-altcha path source/modules/mmd/altcha-integration
composer require mmd/oxid7-altcha-integration:*

Then register and activate the module as with Composer:

vendor/bin/oe-console oe:module:install-configuration source/modules/mmd/altcha-integration
vendor/bin/oe-console oe:module:activate mmd_altcha
vendor/bin/oe-console oe:cache:clear

What happens on activation

Activation creates two tables if they do not exist yet: mmd_altcha_rate_limit_log and mmd_altcha_used_challenges (structure on the Technical page). The HMAC secret is not created on activation but on first access, and is then saved in the module settings.

You find the settings of the module "ALTCHA Spam Protection" in the module settings in the OXID admin (see Configuration).

Update

composer update mmd/oxid7-altcha-integration
vendor/bin/oe-console oe:cache:clear

Uninstall

vendor/bin/oe-console oe:module:deactivate mmd_altcha
composer remove mmd/oxid7-altcha-integration
vendor/bin/oe-console oe:cache:clear

Deactivating and removing the module does not delete the two tables. If you no longer need them, drop them manually with DROP TABLE mmd_altcha_rate_limit_log, mmd_altcha_used_challenges;.