Skip to content

Installation and Upgrade

Matt MacDougall edited this page Sep 9, 2026 · 2 revisions

Installation and upgrade

Install the module on staging first. Feed generation writes files and records queue, schedule, upload, and status data. A saved upload can also transfer completed files to an external system.

Documentation baseline: release v1.0.0. Last reviewed: 2026-09-09.

Before installation

  1. Confirm the target Mage-OS or Magento Open Source and PHP versions are supported.
  2. Record the exact module commit or package version.
  3. Back up the database and relevant media and configuration files.
  4. Confirm Magento cron is healthy.
  5. If a Rocket Web feed package is installed, read Migration and coexistence.
  6. Plan to keep new schedules and uploads disabled until a generated file has been reviewed.

Composer installation

The package is listed on Packagist. Install the stable 1.x line:

composer require 'mage-os/module-shopping-feed:^1.0'
bin/magento module:enable MageOS_ShoppingFeed
bin/magento setup:upgrade
bin/magento cache:clean

In production mode, complete the normal deployment steps for the project, including dependency-injection compilation and static-content deployment where required.

Source installation

Place or symlink the source at:

app/code/MageOS/ShoppingFeed

Use the v1.0.0 tag for a reproducible 1.0 installation, and record its resolved commit.

Then run:

bin/magento module:enable MageOS_ShoppingFeed
bin/magento setup:upgrade
bin/magento cache:clean

Verify the installation

bin/magento module:status MageOS_ShoppingFeed
bin/magento list mage-os:shopping-feed

Then verify:

  • Catalog > Mage-OS Shopping Feed > Feeds Management opens for an authorized administrator.
  • Stores > Configuration > Mage-OS > Mage-OS Shopping Feed is available.
  • The mageos_shopping_feed_* tables exist.
  • The Admin and storefront load without new PHP or JavaScript errors.
  • bin/magento setup:di:compile succeeds in the intended production configuration.

Upgrade

Upgrade through the same installation path used for the module:

  1. Record the current and target versions or commits.
  2. Back up the database and generated feed configuration.
  3. Update the Composer package or source checkout.
  4. Run bin/magento setup:upgrade.
  5. Clean the required caches and complete the project's deployment steps.
  6. Regenerate a non-production feed and compare it with the previous accepted output.
  7. Re-enable schedules and uploads only after the new output is accepted.

When upgrading an existing dev-main installation to 1.0.0, change its Composer constraint to ^1.0 and run the same steps. No schema change is needed for the final review fixes. JSON-looking text settings are now stored with an explicit string marker; downgrading to older development code requires keeping the corrected decoder or restoring compatible configuration data from backup.

Do not copy old installation instructions

Instructions for rocketweb/module-google-shopping, Magento Marketplace access keys, rocketshoppingfeed:* commands, or a pub/media/feeds output directory belong to the older Rocket Web packages. They do not install or operate MageOS_ShoppingFeed.

Clone this wiki locally