README

This extension streamlines the process of copying CMS contents between two enviroments. It works seamlessly with any number of configurations, media files, styles, or blocks, reducing the need for manual work.

Features

- Bi-directional CMS synchronization (push & pull)

- Supports CMS blocks, pages, and widgets

- Batch and single-entity synchronization

- REST API–driven, environment-agnostic architecture

Installation

Composer

Require the package:

composer require sutunam/module-cms-data-sync

Then, execute the following Magento commands:

bin/magento module:enable Sutunam_CmsDataSync
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Configurations:

Go to Stores > Configuration > Sutunam > Cms Data Sync

Descriptions of configurations:

• Enable – Turn the extension on or off.

• Website Name – Name of the remote site you want to copy content from.

• Website URL – The web address of the remote site, used to connect to its API.

• Username – Admin login name for the remote site.

• Password – Admin password for the remote site.

• Sync Media – Turn this on if you also want to copy images and other media files.

• Root Directory / Subdirectory – The folder location on the remote site where its media files are stored (used only if Sync Media is on).

• Overwrite Content (recommended: keep off) – If on, it will replace existing content on your site with the remote site’s content.

Usage:

Note:

You can sync CMS data using any of the three available options:

• Primary “Sync All” button in the UI listing.

• Mass Action option in the CMS listing view.

• Sync button on the CMS block/page edit screen.

The CMS block or page is matched and synced based on its Identifier and Store Views. Simply click the desired sync option, and the CMS data will be transferred automatically.

Some common cases:

1. “Sync Media” Setting

• On – Media files are synced along with CMS content.

• Off – Media files are skipped during syncing.

1. “Overwrite Content” Setting

Enabled

• All CMS blocks/pages are replaced with the remote host’s content.

• If Sync Media is also On, associated media files are replaced as well.

• Two scenarios:

• Block/Page exists → Content is updated with the remote host’s version.

• Block/Page does not exist → A new block/page is created using the remote host’s data.

Disabled

• Existing CMS blocks/pages on the target site are skipped during syncing.

• Any CMS block/page that does not exist on the target site is created using the remote host’s data.

Screenshot:

1. In listing page:

2. In each page:

Note: The cms page management is the same as the block ui listing page

Layouts

This module introduces the following layouts and layout handles in the view/adminhtml/layout directory:

• adminhtml_widget_instance_block
• adminhtml_widget_instance_edit
• adminhtml_widget_instance_index

Development by Sutunam

We are an Open Source Software Development Company, specialized in Magento 2 and Hyva Silver Partner

Contact us