User Guide for CS-Cart Image Background Remover

CS-Cart Image Background Remover effortlessly erases unwanted backgrounds from product photos, category visuals, and logos while keeping the image quality intact.

This AI-powered tool works with popular formats like JPG, JPEG, and PNG, allowing you to edit single or multiple images at once.

Whether you want a transparent background or a clean white one, this tool makes the process quick and seamless.

• Background removal from category and product images and their variations.
• Edit single or multiple images at once.
• Removes background from store theme logos.
• Eliminates backgrounds from company and shipping logos.
• AI-powered for fast and accurate results.

Add minimum server requirements to set up python API as mentioned here.

Note: To access the module’s live demo, please contact the Webkul support team.

Note: Server should not be shared-hosted.

Explore our CS-Cart Vendor Order Accept add-on that allows admin and vendors review customer orders and accept or cancel them.

Here is the installation guide to set up api installation.

Minimum System Requirement (API Setup)

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)

To install AI module, we need SSH access. You can also check the AI Models Server Installation

When you download the add-on, you get one zip file and the install.txt file. Please read it carefully and follow it.

Firstly click on the icon and select Manual Installation to upload the zip file as per the below screenshot.

Click on “Local” to browse the zip file and then click on “Upload & Install” as shown below in the snapshot.

This project provides an API for background removal from images. It allows you to remove image backgrounds and optionally replace them with a custom background or a specified CMYK color.

Prerequisites

• Python 3.9 or above
• `virtualenv` (for creating a virtual environment)
• Postman (optional, for testing API)
  

Note: You can either complete the API installation yourself or request assistance from our team.

Setup Instructions

1. Create a Virtual Environment
You need to create a virtual environment to manage the project’s dependencies.
Option 1:Using `virtualenv`:

• virtualenv myenv

Option 2:Using`venv` (comes with Python):

• python3 -m venv myenv

2. Activate the Virtual Environment

On Windows:

• myenv\Scripts\activate

On macOS/Linux:

• source myenv/bin/activate

3. Install Required Packages
Once the virtual environment is activated, install the project dependencies:

• pip install -r requirements.txt

4. Configure Environment Variables

Create a `.env` file in the root of your project (if it doesn’t already exist) and add the following configuration:

• TOKEN = ‘j6v…clZB’ Replace with your API token.
• HOST = ‘localhost’ Replace with your desired host
• PORT = ‘5000’ Replace with the port number you want to run the server on
  

Note: You can generate a API token by running the following command in your terminal

• openssl rand -base64 48

Make sure that the `.env` file is properly configured with the correct values.

This configuration will be used by Flask to run the application.

5. Run the Flask Application

After configuring your environment variables, you can run the Flask API server:

• nohup python app.py &

After installation of the add-on, you will find Image Background Remover in the list of the available add-ons, we will then configure the settings.

Click on “settings” to Enable, Disable, Install or Refresh. Make sure, the add-on is activated as shown in the below snapshot.

After the installation of the Addon, you have to open the settings of the module. Shown as below:

Under the General Settings, the admin can add the API URL and Token. Further, click on the save button to enable the module.

Admin will navigate to the product create or edit page and from there the admin will see the option of removing background from images under the product images section.

As shown in the above image, the admin can also bulk remove the background of all images.

After the product image background is removed, the admin can also remove the category image background as shown below image.

Admin gets the option to remove the website logo background by navigating to Website > Themes > Site Logo.

Also, the admin can remove the vendor and invoice logo background as shown below image:

Now, when the customer comes on the product page, they will see the product images without background which will give them a good visual appeal.

Once the admin removes the background from the website logo. This is how it will reflect on the storefront –

That’s all for the CS-Cart Image Background Remover.

If you have any questions, suggestions, or customization requests, feel free to contact us at support@webkul.com or submit a ticket at webkul.uvdesk.com.

You may also check our quality CS Cart Extensions.