1. Home
  2. Docs
  3. Magento 2 Product Improvement Extensions
  4. Magento 2 Custom Option Image
  5. Installation Guide

Installation Guide

After you have finished with the purchasing process, we’ll send you an email containing all the links you need to download this extension.

(Please turn off Merge-JS before installing the module. Only Turn on Merge-JS again when finishing the installation.)

I. Install a new module

1. Install the Custom Option Core module

When installing a new Custom Option Image module, it is required to install the Custom Option Core module. Only with the Custom Option Core module installed, then the Custom Options Image extension can work well.

Please follow these steps:

Step 1:

Download the Core Module

Step 2:

Create a directory:

[Magento root folder]/app/code/Bss/CustomOptionCore

Step 3:

Unzip the source code of the extension to the directory created in step 2.

Step 4:

Go to Magento 2 root directory and run the following commands:

  • php bin/magento setup:upgrade
  • php bin/magento setup:di:compile
  • php bin/magento setup:static-content:deploy
  • php bin/magento cache:clean

2. Install the Magento 2 Custom Option Image extension

Step 1:

Unzip the file.

Step 2:

Create another directory called app/code/Bss/CustomOptionImage/. CustomOptionImage is the module’s internal identifier. You can find it in the “composer.json” file in the extension ZIP file you downloaded, look at the node “psr-4”.

This is what you call the directory, and then you put the contents of the extension ZIP file in there.

Step 3:

Upload the directory app/code/Bss/CustomOptionImage/ into the root directory of your Magento installation. The root directory of Magento is the directory that contains the directories “app”, “bin”, “lib” and more. All directories should match the existing directory structure.

Step 4:

Go to Magento 2 root directory.

Run: php bin/magentosetup:upgrade.

Step5:

Run: php bin/magentosetup:static-content:deploy.

Step 6:

Clear all Caches.

II. Upgrade the extension to the new version

If you are already using Custom Option Image extension, and what to upgrade to a newer version (from 1.1.5), please follow the instructions below:

Step 1:

Download the new extension version (including the Custom Options Core module).

Step 2:

Delete the previous code in the directory:

[Magento root folder]app/code/Bss/CustomOptionImage/

Step 3:

Unzip the source code of the new extension version to the directory.

Step 4:

Go to Magento 2 root directory and run the following commands:

  • php bin/magento setup:upgrade
  • php bin/magento setup:di:compile
  • php bin/magento setup:static-content:deploy
  • php bin/magento cache:clean

III. Install/Uninstall/Disable the Hyva Theme Compatibility package

The following instruction is used for the Hyva theme compatibility package ONLY.

  • To install the Hyva compatibility package:

1. Install via composer, run commands:

- composer require hyva-themes/magento2-bsscommerce-custom-option-image

*Note: When install the compatibility package via composer, you also need to install 2 other modules bsscommerce/custom-option-image and hyva-themes/magento2-compat-module-fallback via composer.

2. Install via gitlab, run commands:

- composer config repositories.hyva-themes/magento2-compat-module-fallback git git@gitlab.hyva.io:hyva-themes/magento2-compat-module-fallback.git

- composer config repositories.hyva-themes/magento2-bsscommerce-custom-option-image git git@gitlab.hyva.io:hyva-themes/hyva-compat/magento2-bsscommerce-custom-option-image.git

- composer require hyva-themes/magento2-bsscommerce-custom-option-image:dev-main

- Finally, run command: php bin/magento s:up

  • To disable the Hyva compatibility package, run commands: 

- php bin/magento module:disable Hyva_BssCustomOptionImage

  • To uninstall the Hyva compatibility package, run commands:

- composer remove hyva-themes/magento2-bsscommerce-custom-option-image

*Note

After purchasing this module, just add our Skype account at support.bsscommerce, BSS Support Team will help you to install this extension immediately. Further assistance is available via Email and Skype.

In case you have followed all the above steps but the extension still doesn’t work properly, you can delete the file or change the module’s filename to keep your website function as normal. Then please contact us via sales@bsscommerce.com or Skype: support.bsscommerce, our supporters will assist you in resolving any issues within 24 hours.

Was this article helpful to you? Yes No 1

How can we help?