Installation

Package contents

Download the plugin package OrbitvuShM2-<version>.zip from your ORBITVU SUN account. Orbitvu SELF HOSTED V2 is version 2.0.0 or higher: packages with version 1.x (for example OrbitvuShM2-1.2.1.zip) are the previous plugin. The package contains:

• app/code/Orbitvu/SelfHostedV2 – the plugin, with the default Orbitvu Viewer,
• hyva/app/code/Orbitvu/SelfHostedV2Hyva – the compatibility module for Hyvä themes, needed only by stores with a Hyvä theme.

Installing the plugin

Open the server command line, go to the Magento root directory and run (replace <magento_root> and <version>):

unzip OrbitvuShM2-<version>.zip -d orbitvu-package
cp -r orbitvu-package/app <magento_root>/
cd <magento_root>
bin/magento module:enable Orbitvu_SelfHostedV2
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

setup:upgrade creates the plugin tables and copies the default Orbitvu Viewer to pub/media/orbitvu/viewer. In developer mode, setup:di:compile and setup:static-content:deploy can be skipped.

Make sure that the web server user can write to pub/media/orbitvu. Otherwise uploading presentations fails, and the Orbitvu tab of the product edit page shows a warning.

Hyvä themes

Store views with a Hyvä theme also need the compatibility module from the hyva/ directory of the package. Luma-based store views do not need it.

cp -r orbitvu-package/hyva/app <magento_root>/
cd <magento_root>
bin/magento module:enable Orbitvu_SelfHostedV2Hyva
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

Adobe Commerce Cloud

On Adobe Commerce Cloud, files cannot be copied to the server: the code is deployed from the project's Git repository. Copy the plugin (and the Hyvä module, if needed) into app/code of a local copy of the project, enable it there, then commit and push:

cp -r orbitvu-package/app/code/Orbitvu/SelfHostedV2 <project>/app/code/Orbitvu/
cd <project>
bin/magento module:enable Orbitvu_SelfHostedV2
git add app/code/Orbitvu app/etc/config.php
git commit -m "Add Orbitvu SELF HOSTED V2"
git push

The deployment runs setup:upgrade, which also installs the Orbitvu Viewer in pub/media. Nothing has to be uploaded to pub/media by hand.

After the installation

1. Copy the Remote Upload URL to Orbitvu Station, see Uploading Orbitvu presentations to the shop.
2. Check the settings in Stores → Configuration → Orbitvu Self Hosted V2, see Plugin settings.