Guide for Adobe Commerce Image Background Removal

• Admin can enable or disable the module.
• Allows the admin to remove and replace the background of the images.
• This module supports images in such formats as JPG, JPEG, and PNG.
• Admin can choose the processing method – External Service or Client Side Processing.
• Background removal can remove or replace the background of product images, single and multiple from the admin end.
• This module can remove or replace the background of category images.
• Admin can also remove the background from the header logo and head shortcut icon.
• The admin can set the host dynamically.

The following minimum system requirements are needed for this extension,

• Python Version – 3.10
• Space (4 GB)
• RAM (2 GB)
• Server key and cert files (for Flask API)
• Port (5000)

The installation is quite simple just like the standard Magento 2 extensions.

#1Download Module

Firstly, log into the Webkul Store, navigate to My Account>My Purchased Products, verify, and then download and extract the contents of this zip folder on the system.

#2 Upload Folder

Once the module zip is extracted, navigate to path src>app and copy the app folder to the Magento 2 root directory on the server, as shown below:

#3 Run Commands

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php bin/magento indexer:reindex

php bin/magento cache:flush

Therefore, for Multilingual support, please navigate to Store>Configuration>General >Locale Options.  Also, select your desired language from the Locale option.

Thus, in this way, a multi-lingual configuration can be done.

For Magento 2 Background Removal translation, navigate to the following path in your system src/app/code/Webkul/BackgroundRemoval/i18n.

Open the file named en_US.CSV for editing as shown in the below screenshot.

Now, upload it to the path src/app/code/Webkul/BackgroundRemoval/i18n where the installation of Magento 2 is on the server. The module gets translated into the desired language.

The user can edit the CSV like the image below.

After editing and translating the CSV file, you need to save the translated file name according to your region language and country code such as – de_DE.CSV.

Followed by uploading the translated file to the same folder from where you have obtained it. Now your module translation is complete.

Thus, you can translate language in this way.

After the extension installation, the admin will configure the module setting by navigating

to Dashboard > Background Removal > Configuration Settings as per the below image:

Background Removal Configuration

• Enable: The store admin can enable or disable the background removal.
• Processing Method: Choose how the image background will be removed:
  • External Service – Images are processed using an external API service.
    When selected, you must enter:
  • Host Name – The API endpoint
  • API Token Key – Secure authentication key
• Client Side Processing – Background removal is handled directly in the browser without using any external server.

After selecting the preferred method, click Save Config to apply the settings.

Now, Let’s dive into the admin end workflow of Image background removal.

To remove or replace the background of category images, navigate to: Catalog > Categories > Content > Category Image

The admin can upload category images using multiple options such as Upload, Select from Gallery, or by simply drag-and-drop.

After adding the image, the module provides two background editing options:

• Remove Background – Automatically removes the existing background from the image.
• Replace Background – Removes the background and lets the admin apply a new background of their choice.

Once the desired action is performed, click Save to update the category image.

Now, the background of the image has been removed.

Now, we will see the category images on the customer end, after logging into the website click on the Men category.

Here, you can see that we have already removed the category image background.

So, this is the working of background removal.

To remove or replace the background of product images, navigate to: Catalog > product > Create new or edit existing > images and videos.

Here, you can upload the image by tapping on the attachment and then selecting the image.

When editing a product image, click on the image to open the Image Detail popup.

Here, the module provides two options:

• Remove Background – Automatically removes the background.
• Replace Background – Removes the background and applies a new one.

After selecting either option, a Confirm Image Edits button appears.
Click this button to apply the changes and update the product image.

Here, we have removed the background of the product image.

Let’s see the product image on the customer end.

Log in to the customer account navigate to Categories > Product

The background of the product image has already been removed here.

Here, we can also change the Favi icon of the store by navigating to Content > Design > Configuration > HTML Head.

Click on the upload button select the image and click on remove or replace background as shown below:

Now, click on the save configuration and you can see that the Background of the Favi Icon image removed.

Here, you can also remove or replace the background of the Logo Image by navigating to

Content > Design > Configuration > Header

Click on the upload button and select the image.

Now click on background removal as shown below:

Here, you can see that we have removed the background of the image.

Here on the customer end, you can see the logo image for which you have removed the background.

At the top of the website, the logo is visible.

That’s all for the Magento 2 Image Background Removal Extension.

If you still have any issues feel free to add a ticket and let us know your views to make the module better at  webkul.uvdesk.com.