Install and upgrade

Requirements

  • Magento Open Source, Mage-OS or Adobe Commerce 2.4.7, 2.4.8 or 2.4.9, PHP 8.2 to 8.4.
  • For the storefront on Hyvä: the Hyvä default theme 1.4 or 1.5 (1.3: best effort). Other themes: see Custom themes.
  • MSI is optional.
  • Remote storage (Magento_RemoteStorage, e.g. Amazon S3): OpenLabel writes its stylesheets and label images through Magento's filesystem, so it should work, but it is not tested yet.

Install

composer require iranimij/openlabel-hyva-bundle
bin/magento setup:upgrade
bin/magento openlabel:reindex

The bundle installs iranimij/openlabel (core), iranimij/openlabel-hyva (Hyvä storefront) and iranimij/module-base (the "Iranimij" configuration tab). Without Hyvä, require iranimij/openlabel only.

In production mode also run, as for any module:

bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

No theme build is needed: the storefront CSS is generated by OpenLabel into pub/media/openlabel/<store_id>/openlabel.<hash>.css on first use and after every label or design change.

After installing

  • Catalog › OpenLabel › Labels: create a first label from a starter (Admin).
  • Stores › Configuration › Iranimij › OpenLabel: enable or disable per store view, default max labels per position, debug mode, "Regenerate CSS".
  • Indexer: openlabel_product runs after the price and stock indexers. "Update by schedule" is recommended as for every indexer; the hourly and daily OpenLabel cron jobs need Magento's cron.

Upgrade

composer update iranimij/openlabel-hyva-bundle --with-dependencies
bin/magento setup:upgrade
bin/magento openlabel:reindex
# production mode: new admin scripts and templates
bin/magento setup:static-content:deploy

setup:upgrade rebuilds the label stylesheet of every store, so the new version's styles reach the shop at once.

Upgrade notes for each version are in the CHANGELOG. Everything in Api/ follows semantic versioning: no breaking change within 1.x.

Uninstall

bin/magento module:uninstall -r Iranimij_OpenLabelHyva Iranimij_OpenLabel

Removes the modules, the openlabel_* tables and OpenLabel's configuration. With a plain Composer remove, run bin/magento setup:upgrade afterwards; the tables stay until you drop them.