addeos/anonymize

Anonymization command

2.0.1 2024-01-25 21:07 UTC

Requires

• php: ~7.4||8.*

OSL-3.0

• Didier Berlioz

README

A magento 2 module that let you anonymize the private data that are present in your MySql database using a specific CLI command.

Table of Contents

1. Introduction
2. Installation
3. Enabling the extension
4. Configuration
5. CLI command
6. List of tables anonymized
7. Running in developer mode
8. Running in Force mode (production)
9. Troubleshooting
10. Support and contact

Introduction

The Addeos Anonymize Extension is designed to help Magento store owners comply with GDPR regulations by providing a simple and efficient way to anonymize sensitive customer data on local environments. This extension ensures that personal information in specified database tables is anonymized, making it suitable for development and testing environments.

Installation

To install the Addeos Anonymize Extension, follow these steps:

composer require addeos/anonymize
php bin/magento module:enable Addeos_Anonymize
php bin/magento setup:upgrade

Enabling the Extension

After installation, enable the extension using the following command:

php bin/magento module:enable Addeos_Anonymize
php bin/magento setup:upgrade

Configuration

A new configuration section Addeos > Anonymize is visible in BO.

In that section, you will find a few fields that will allow you to define which tables and which tables will be anonymized.

Some default values are set.

The tables that will be anonymized can be configured.

All different types of columns that will be anonymized can be configured.

The generic strings type columns : The phone columns : The password type columns : The email type columns : The IP type columns :

CLI Command

Once the extension is enabled, a new CLI command becomes available:

php bin/magento addeos:anonymize

Use this command to initiate the anonymization process.

List of Tables Anonymized

The Addeos Anonymize Extension anonymizes data in the following database tables:

• customer_entity
• customer_address_entity
• customer_grid_flat
• email_contact
• newsletter_subscriber
• paradoxlabs_stored_card
• quote
• quote_address
• sales_creditmemo_grid
• sales_invoice_grid
• sales_order
• sales_order_address
• sales_order_grid
• sales_shipment_grid
• stripe_customers

Ensure that you have a backup of your data before running the anonymization process.

Running in Developer Mode

The extension can only be executed on a Magento installation in developer mode. Ensure that your Magento environment is set to developer mode before running the anonymization command.

Logs are available in a log file named addeos-anonymize.log.

Running in Force Mode (Production)

In a production environment, you can run the extension in force mode by adding the -f or --force parameter to the command:

php bin/magento addeos:anonymize -f

Note: Exercise caution when using force mode on a production Magento installation, and always have a backup of your data.

Troubleshooting

If you encounter any issues during installation or usage, consider the following troubleshooting steps:

• Check the Magento logs for error messages.
• Ensure that the extension is properly enabled using the `php bin/magento module:status command.
• Verify that the CLI command syntax is correct.

Support and Contact

For any further assistance, reach out to our support team at [e-mail]. We are here to help you with any questions or concerns regarding the Addeos Anonymize Extension.

Thank you for choosing Addeos to enhance your Magento experience!