Skip to main content
V
Vensa
Docs/Magento

Magento Setup Guide

Install the Vensa Virtual Try-On extension on Magento 2 / Adobe Commerce.

Requirements

  • Magento 2.4.6 or higher / Adobe Commerce
  • PHP 8.1 or higher
  • Composer 2.x
  • SSL certificate (HTTPS)
1

Purchase & Get Your License Key

  • Purchase a Magento plan from the Pricing page.
  • After payment, log in to your Vensa Dashboard at vensa.app/account.
  • Copy your License Key from the Licenses section — you'll need it for Composer authentication.
2

Add Vensa Composer Repository

  • Add the Vensa private repository to your project's composer.json:
  • Run: composer config repositories.vensa composer https://vensa.app/api/composer/packages.json
  • This tells Composer where to find the Vensa packages.
3

Configure Authentication

  • Create or edit auth.json in your Magento root directory (or ~/.composer/auth.json for global config):
  • Run: composer config --auth http-basic.vensa.app YOUR_LICENSE_KEY YOUR_LICENSE_KEY
  • Replace YOUR_LICENSE_KEY with your actual license key (used as both username and password).
  • Alternatively, add manually to auth.json: { "http-basic": { "vensa.app": { "username": "YOUR_LICENSE_KEY", "password": "YOUR_LICENSE_KEY" } } }
4

Install via Composer

  • Run: composer require vensa/virtual-tryon
  • Composer will authenticate with your license key automatically.
  • Run: bin/magento module:enable Vensa_VirtualTryon
  • Run: bin/magento setup:upgrade
  • Run: bin/magento setup:di:compile
  • Run: bin/magento cache:flush
5

Activate Your License

  • Go to Stores → Configuration → Vensa → Virtual Try-On.
  • Enter your license key from your Vensa dashboard.
  • Click Save Config — the license will be activated automatically.
6

Configure the Extension

  • Enable/Disable: Toggle the extension on or off.
  • Product Categories: Select which categories show the try-on button.
  • Button Styling: Customize colors, text, and positioning.
  • Widget Mode: Choose modal or inline display.
7

Deploy & Verify

  • Run: bin/magento setup:static-content:deploy (production mode).
  • Visit a product page to verify the try-on button appears.
  • Test the try-on flow with a sample photo.

How Composer Authentication Works

  • Your license key acts as both your username and password for Composer HTTP Basic Auth.
  • Only active licenses can download packages. Expired or suspended licenses will be denied.
  • Running composer update vensa/virtual-tryon will pull the latest version available under your license.
  • Keep your auth.json out of version control — add it to your .gitignore.

Hyvä Theme Support

If you're using the Hyvä theme, install the compatibility module:

composer require vensa/virtual-tryon-hyva
Get the ExtensionNeed Help?