2017-09-22 14:12:28 +02:00
|
|
|
# Simple captcha module
|
|
|
|
|
|
|
|
|
|
## Description
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2016-03-23 12:32:27 +01:00
|
|
|
This module provides a simple captcha ("Completely Automated Public Turing test to tell Computers and Humans Apart")
|
|
|
|
|
challenge (distorted characters in an image).
|
|
|
|
|
|
|
|
|
|
It is used to ensure that only a user who can read the distorted characters and enter them in the related input field
|
|
|
|
|
can submit the following forms:
|
|
|
|
|
- contact
|
|
|
|
|
- invite
|
|
|
|
|
- pricealarm
|
|
|
|
|
- suggest
|
|
|
|
|
|
|
|
|
|
The captcha module then validates the submitted value against the expected one and then decides whether to process the
|
|
|
|
|
request (e.g. send contact mail to shop administrator) or refuse and show an error message instead.
|
|
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
Please proceed with one of the following ways to install the module:
|
|
|
|
|
|
|
|
|
|
### Module installation via composer
|
|
|
|
|
|
|
|
|
|
In order to install the module via composer, run the following commands in commandline of your shop base directory
|
|
|
|
|
(where the shop's composer.json file resides).
|
|
|
|
|
|
|
|
|
|
```
|
2017-12-05 14:29:47 +01:00
|
|
|
composer require oxid-projects/captcha-module
|
2017-09-22 14:12:28 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Module installation via repository cloning
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
Clone the module to your OXID eShop **modules/oe/** directory:
|
|
|
|
|
```
|
|
|
|
|
git clone https://github.com/OXIDprojects/captcha-module.git captcha
|
|
|
|
|
```
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
### Module installation from zip package
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
* Make a new folder "captcha" in the **modules/oe/ directory** of your shop installation.
|
|
|
|
|
* Download the https://github.com/OXIDprojects/captcha-module/archive/master.zip file and unpack it into the created folder.
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
## Activate Module
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
- Activate the module in the administration panel.
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
## Uninstall
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
Disable the module in administration area and delete the module folder.
|
2016-03-21 16:06:24 +01:00
|
|
|
|
2017-09-22 14:12:28 +02:00
|
|
|
## License
|
2016-03-21 16:06:24 +01:00
|
|
|
|
|
|
|
|
Licensing of the software product depends on the shop edition used. The software for OXID eShop Community Edition
|
|
|
|
|
is published under the GNU General Public License v3. You may distribute and/or modify this software according to
|
|
|
|
|
the licensing terms published by the Free Software Foundation. Legal licensing terms regarding the distribution of
|
|
|
|
|
software being subject to GNU GPL can be found under http://www.gnu.org/licenses/gpl.html. The software for OXID eShop
|
|
|
|
|
Professional Edition and Enterprise Edition is released under commercial license. OXID eSales AG has the sole rights to
|
|
|
|
|
the software. Decompiling the source code, unauthorized copying as well as distribution to third parties is not
|
|
|
|
|
permitted. Infringement will be reported to the authorities and prosecuted without exception.
|
