OrbitvuOrbitvu

Migrating from the previous plugin

Move presentations, product links and settings from the previous Orbitvu SELF HOSTED plugin (Orbitvu_SelfHosted) to Orbitvu SELF HOSTED V2 with one command.

Use this procedure when the shop uses the previous Orbitvu SELF HOSTED plugin (module Orbitvu_SelfHosted). The migration command copies its presentations, product links and settings to Orbitvu SELF HOSTED V2. The previous plugin is not changed, and its files are copied, not moved.

Before you start

Back up the database and the files of the shop. On a production shop, run the migration in maintenance mode (bin/magento maintenance:enable).

  1. Install Orbitvu SELF HOSTED V2 next to the previous plugin, see Installation. Do not remove the previous plugin yet.
  2. Run the commands below as the owner of the Magento files (not as root). The user must be able to write to pub/media/orbitvu.

While the previous plugin is enabled, product pages still use its gallery, and the back office shows a message asking to migrate.

The previous plugin kept presentations in _orbitvu_presentations in the Magento root directory, or in pub/_orbitvu_presentations when its Legacy Mode setting was disabled. The migration finds them in both places. If they are somewhere else, add --legacy-path=<absolute path> to the commands.

Step 1: preview the migration

bin/magento orbitvu:selfhostedv2:migrate-from-legacy --copy-files --dry-run

Nothing is changed. The output lists the presentations that would be copied and synchronized, and those that cannot be found.

Step 2: run the migration

bin/magento orbitvu:selfhostedv2:migrate-from-legacy --copy-files
bin/magento cache:flush

The migration:

  • copies the settings of the previous plugin (settings already changed in V2 are kept, unless you add --overwrite-config),
  • copies the presentation folders to pub/media/orbitvu/presentations,
  • links the presentations to the same products, with the same item order and visibility,
  • keeps the unlink history, so automatic linking does not link again what was unlinked by hand,
  • skips links to products that no longer exist and reports them.

The command can be run again safely: what was already migrated is kept.

Not migrated: the secret URLs and the uploaded viewer versions. After the migration, paste the new Remote Upload URL into Orbitvu Station, update cron jobs with the new Auto Synchronizing URL and Auto Linking URL, and upload custom viewer versions again.

Step 3: disable the previous plugin

bin/magento module:disable Orbitvu_SelfHosted
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

Product pages now use the Orbitvu SELF HOSTED V2 gallery. Check a few products with presentations. When everything works, the old _orbitvu_presentations and _orbitvu_viewer directories can be removed (keep a backup).

Command options

OptionDescription
--dry-runPreview only, nothing is changed.
--copy-filesCopy the presentation folders of the previous plugin to Orbitvu SELF HOSTED V2.
--legacy-path=PATHAbsolute path of the _orbitvu_presentations directory of the previous plugin, when it is not in the Magento root or in pub/.
--skip-configDo not copy the settings.
--overwrite-configReplace settings already changed in V2 with those of the previous plugin.
--batch-size=NNumber of records processed at a time (default 100).

On this page

Before you startStep 1: preview the migrationStep 2: run the migrationStep 3: disable the previous pluginCommand options