This extension works with Magento Community Edition and also Magento Enterprise Edition. To know if Shop By Brand is compatible with your Magento version, please check the Compatibility tab.

Magento offers three variations of its product.

As their names have changed over the past few years, here is a recap:

• Magento Open Source: previously Magento Community Edition (CE), is a free and non-hosted e-commerce platform.
• Magento Commerce: previously Magento Enterprise (EE), is the paid version of Magento and offers support services.
• Magento Commerce Cloud: is the paid version of Magento and offers support and hosting services.

A license is valid for an unlimited period of time on one single installation

• If you're using more than one installation, you will have to buy a separate license for each instance.
• if you're running several domains on a same installation, you will need only one license for all of them.

You can pre-register your live domain to your license in advance.

Thanks to this option, you'll be able to get the module ready to use on your domain before it goes live.

To pre-register your production domain: 

1. Go to:
   mY accountLicenses & DOwnloads
2. Click on the Settings icon next to the module you want your domain to pre-register on.
3. Click on the link at the bottom of the page saying:
   Do you want to pre-register your domain in order to be ready to go live?
   
4. Finally, enter your domain name and click on pre-register now .
   
   

One license is valid for an unlimited period of time on one installation only. However, it is possible to extend or transfer your license in 2 cases: 

• If you would like to add your testing environments to your license. 
  In that case, it is possible to extend your license to an unlimited number of domains for free.
  For  mywebsite-staging.com or mywebsite-dev.com
• If you want to transfer your license to another live domain.
  In that case, the Support & Upgrade period for your license must still be active.

To be able to use Shop By Brand on both your production and testing environments, follow the instructions below:

1. Download Shop By Brand.
   (see FAQ: Extensions download)
2. Install Shop By Brand on your environment.
   (see FAQ: Modules installation in Magento or in WooCommerce)
3. Activate the license.
   (see FAQ: Licenses activation in Magento or in WooCommerce)

In order to download Shop By Brand, log into your Wyomind account:

1. Go to:
   my accountLicenses & downloads 
2. Click on the settings icon next to Shop By Brand.
   
   

   A new window opens.

3. Click on the download icon.
   

When purchasing a module from wyomind.com, you benefit from 12 months of upgrade. Within this period you can at any time download the latest version of the module directly from your account.

To upgrade Shop By Brand, follow the steps below:

1. Go to:
   my accountLicenses & Downloads
2. Click on the settings icon next to Shop By Brand.
3. Click on the download icon.
4. Install the new version of Shop By Brand in your Magento admin or your WooCommerce back-office.

You can install Shop By Brand manually.

1. Download Shop By Brand (zip file) on:
   mY ACCOUNTLicenses & Downloads
    
   Refer to the FAQ: Extensions download
2. Once Shop By Brand is downloaded, open the folder and unzip it.
3. Copy the content of the unzipped folder and paste all files and directories in your Magento 2 root directory.
   
4. In your Command Line Interface, execute:
   

   bin/magento setup:upgrade 

   If you are using a production mode, execute also:

   bin/magento setup:static-content:deploy  

   bin/magento setup:di:compile  

You can install Shop By Brand using Composer software in two cases:

• if you purchased Shop By Brand on Magento Marketplace.
• if you purchased Shop By Brand on Wyomind.com AND requested access to our repository:
  repo.wyomind.com

1. Add to your composer configuration our repository:
   

   composer config repositories.wyomind composer https://repo.wyomind.com 

   
   
2. Execute Composer command:
   

   composer require wyomind/shopbybrand

3. Then go in your Command Line Interface and execute:
   

   bin/magento setup:upgrade ​

4. If you are using a production mode, also execute:
   

   bin/magento setup:static-content:deploy  ​

   bin/magento setup:di:compile​

To uninstall Shop By Brand, start with disabling the extension running the following command:

bin/magento module:disable Wyomind_ShopByBrand

Then, you have 2 ways to uninstall the extension depending on how the extension has been previously installed: 

• Manual installation
  

  Run the shopbybrand-uninstall.sh file (you can find it in the extension zip folder) from your Magento root directory:

  sh shopbybrand-uninstall.sh

   

• Installation via Composer
  

  Run the below command line:

  composer remove wyomind/shopbybrand

Once the uninstallation is over, refresh your cache and enable the compiler back again (if you use it). 

You can install Shop By Brand via Web Setup Wizard if you purchased it from Magento Marketplace only.

To know how to proceed, all steps are described in the link below: 
http://docs.magento.com/m2/ce/user_guide/system/component-manager.html

Next step is to activate your license:
Extension activation

Once Shop By Brand is installed, you have to activate the license. For previous versions, you can activate the license from your back-office:

1. Go to your Magento admin panel. A message pops up at the top of the page.
   

   
   

   If the message doesn't appear then you must check that:
   
      1. The Adminhtml_Notifications and Wyomind_Core modules are well enabled.
      2. The HTML output of the Adminhtml_Notifications and Wyomind_Core modules are not disabled in:
   storesconfigurationadvanced advanced
      3. The encryption key well exists in app/etc/env.php:
   

   <?php
    return array(
    'backend' => array(
    'frontName' => 'admin'
    ),
    'crypt' => array(
    'key' => '1e8f3c6772b7a6a6689c3c8cefa4ccf0'
    ),
    /* ... */
    )
   ?>​

2. Copy your activation key in:
   StoresConfigurationWyomind Your extension
   
   You can find your activation key in 2 different places:
   -  In the confirmation email that you received after purchasing Shop By Brand.
   -  In your Wyomind account:My account Licenses & downloads
   Select Shop By Brand and click on  .
   
   A new page opens where you'll find your activation key (see below).
   
   
   
3. In your Magento admin go to:
   StoresConfigurationWyomind Your extension
   
   Paste the activation key in the Activation Key field and choose between the automatic (yes) or the manual (no) activation method:
   -  By choosing Yes, the connection to Wyomind license server will be automatic.
   -  By choosing No, you will have to log on to Wyomind license server yourself.
   
   
4. Click on Save config .
5. A message appears at the top of your admin panel. Click on that link: 
   Activate it now!
   
6. Copy and paste the license code in the License code field from your admin or simply click on Activate now! 
   
   
   
7. Finally, refresh your cache, log out and log in back straight after, to complete the installation.

Add another domain to your license

To activate the license on another domain (test, staging...):

1. Once the extension is installed on the new domain, copy your activation key in:
   StoresConfigurationWyomind Your extension
2. After having saved the configuration, a notification appears. Click on Add this domain to my license.

   

3. A transfer request will then be sent to our team within an hour.
   Once the request is taken care of, you will receive a confirmation email.
   If your transfer request is accepted, you can use Shop By Brand on both environments at the same time.

Note that the order in which you activate your license on your domains does not matter. You can start with your staging/dev/local environment or with your live domain, the process will be the same.

Once Shop By Brand is installed, you have to activate the license.

For this, you can use the below command line (change the Activation key with the corresponding value):

bin/magento wyomind:license:activate Wyomind_ShopByBrand <YOUR_ACTIVATION_KEY>

To retrieve the list of all the available modules as well as the licenses status, please use:

bin/magento wyomind:license:status

 Among the different status, you can find: 

• registered = your license is registered
• pending = you need to run the activation command line
• invalidated = the license has been invalidated due to a wrong activation key or a license infringement

To activate several licenses at the same time, use:

bin/magento wyomind:license:activate \
Wyomind_Extension1,Wyomind_Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2

or:

bin/magento wyomind:license:activate \
Extension1,Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2