Page tree
Skip to end of metadata
Go to start of metadata

Live Copy helps with managing complex multisite installations that share similar content. It allows you to create referenced copies of master sites. They are automatically updated when changes are performed on the master. This way you only have to manage the master content. There is no need to copy similar pages to multiple locations in order to perform updates. Components on referenced pages can be changed individually and protected from master content changes.

Status INCUBATOR
TypeEnhancement
EditionEE Pro
JIRALIVECOPY
Gitlivecopy

Installation

Maven is the easiest way to install the module. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.multisite</groupId>
  <artifactId>magnolia-livecopy</artifactId>
  <version>${liveCopyVersion}</version>
</dependency>

This module is located in the incubator repository and requires additional changes to your Maven settings file.

Change the widgetset and the theme in the magnolia.properties to:

magnolia.ui.vaadin.widgetset=info.magnolia.liveCopy.widgetset.LiveCopyWidgetSet
magnolia.ui.vaadin.theme=lc

Versions

3.0Magnolia 6.0
2.1.1Magnolia 5.7
2.1Magnolia 5.7
2.0.6Magnolia 5.6
2.0.5Magnolia 5.6
2.0.4Magnolia 5.6

Usage

Live Copy works by creating a copy from a "master" website. The master can be an entire site, a sub-tree, or even just a single page.

To create a copy, open the Pages app, find the site/tree/page, and click the Create live copy action from the actionbar. This will create an exact clone of the selected tree. In the LiveCopy column of the Pages app the two sites will be indicated using one of the two icons. 

Master SiteReferenced Site

The newly created referenced site will follow the same naming convention as the standard copy action. For example, if your master page was named travel, then the new referenced site is named travel0. Most likely you will want to rename referenced site root.

It is possible to copy just a sub-tree or a single page. You just have to move the created copy to the right location afterwards.

Finally, create a matching site definition for your freshly created reference site.

Typically your master site contains links that are internal to the master site. The links in your newly created live copy site will still point to that master content. This can be desirable in some situations. However, there maybe scenarios where the links should point to pages in the reference site. To automatically change the links to your referenced site you can use the Relink live copy pages action. Rewritten links are automatically protected from being overwritten when new content is pushed from master.

Pushing content from master to reference pages

If you changed content on your master page and want to push this content to the matching reference page then you can use the Push master content changes action.

The content in the referenced page will then be updated as follows:

  • Content including personalized content

    This includes page properties, component ordering, added and/or removed components.

  • Page position

    If the master page is moved to a different location, then the reference page will be moved to the equivalent position.

    If the master page is not existing, then the page will stay on the same location.

  • Page variants

Protecting content from master content changes

Components within a reference page are marked with an extra reference icon. This helps you to differ between referenced and non-referenced content.

You may not want that all content in your reference pages is overwritten if master content is pushed. You can protect full pages, single components or even single fields in your component.

  • To protect a full page, select the reference page and click Detach live copy action.

    Detached reference pages are marked with a broken link symbol in the browse view.

  • To protect a component, edit the page, select the component, and use the Remove live copy link action.
  • To protect a field within a component, click edit component, click on the lock symbol, then select the fields that should not be overwritten on the next content push from your master content.

Breaking and reattaching

(warning) Added in v2.0.2

It's possible to break the link of the referenced pages. The linking of referenced pages to master content is done using a page property called masterContentIdentifier. This is visible through the JCR Browser or via content export. To break this linking click the action Break live copy reference. After confirmation, the page will no longer receive updates from the master page.

Breaking the link to master content is achieved through a page property called liveCopyReferenceDropped. When this flag is set to true the linking of content is essentially turned off. However, the masterContentIdentifier still remains and the content can be re-linked at any time. To reattach the referenced content to the master content click the action Reattach live copy node.

Internationalization

For single-tree-multi-language websites there is info.magnolia.liveCopy.i18n.LiveCopyI18nContentSupport to be used in the Live Copy's site definition. This class introduces a masterLocale property which holds the fallback language from the master copy.

Please keep in mind that you have to create a new site definition for every live-copy site you create.


Warnings

  • This module is at INCUBATOR level. 
  • As a lot of content can be referenced and interlinked, a single wrong action can have a negative impact on a big part of your website. Plan your content structure in detail before using Live Copy.

  • Give the rights to execute Live Copy actions to privileged users with sufficient instructions only.

  • Uninstall previous versions before installing 2.0.

Changelog

  • Version 3.0
    • Updated for Magnolia 6.0 compatibility.
  • Version 2.1.1
  • Version 2.1
    • Updated for Magnolia 5.7 compatibility.
    • LIVECOPY-38 - Getting issue details... STATUS
  • Version 2.0.6
  • Version 2.0.5
    • POM edited to prevent versioning clash with magnolia-pages-editor-widget
  • Version 2.0.4
  • Version 2.0.3
  • Version 2.0.2
  • Version 2.0.1
  • Version 2.0 - Initial release of the extensions version of the module.