The method preferred by Magento for installing packages is via "composer". Where this method is unavailable please follow the manual installation instructions below.

Manual Installation

The Omnivore package(s) for Magento 2.1+ are attached to the end of this page, the specific versions and package(s) required are:

  • Magento 2.3+
    • citybeach/omnivore (2.3.3)
    • citybeach/integration (1.0.8)
  • Magento 2.1+
    • citybeach/omnivore (2.1.7)

Once you have downloaded the correct zip file(s):

  1. Make a back up of your site
  2. Copy the zip file(s) to your server
  3. Create the 'app/code/CityBeach' directory in your Magento 2 base directory
  4. Create the 'app/code/CityBeach/Omnivore' directory and unzip the citybeach/omnivore file
  5. For Magento 2.3+ and above create the 'app/code/CityBeach/Integration' directory and unzip the citybeach/integration file
  6. Run the install script via the "php bin/magento setup:upgrade" command
  7. Update the dependency injection,  via the "php bin/magento setup:di:compile" command
  8. Change/check that the file ownership and permissions are still correct.


After the packages are installed you should see 'Omnivore' in the Magento admin page (bottom-left). This link will take you to the Omnivore page on your Magento admin site. 

Click this then click ‘Go to Omnivore’. The "Go To Omnivore" button will then link you to the Omnivore site registration page (or Dashboard once you have registered).

Accept the terms and conditions and click ‘Create account’

If you have any problems connecting to Omnivore, please review these troubleshooting guidelines.