Magnolia BootstrapSync

What does Magnolia BoostrapSync module do?

Magnolia BoostrapSync is a custom magnolia module.

After installed into magnolia, this module will allow you to automatically export to filesystem your changes in magnolia repositories.

The module is intended to be used during development only, and it's mostly useful when developing in team, in order to assure that any configuration change is exported.

Requirements

This module requires magnolia 4.x and will not work on any earlier version!

Installation

Copy all openutils-mgnlbootstrapsync JAR files into Magnolia webapp WEB-INF/lib directory or, if you are using Maven, just declare the following dependency:

<dependency>
   <groupId>net.sourceforge.openutils</groupId>
   <artifactId>openutils-mgnlbootstrapsync</artifactId>
   <version>(see last released version)</version>
</dependency>

Configuration

Configure the magnolia environment.properties file (usually in WEB-INF/config/default folder) as follows:

 #development mode set to true
 magnolia.develop=true
 
 #activate bootstrap synchronization (true/false)
 magnolia.bootstrapSync=true

 #list of repositories you want to configure to be boostrapped into xml files
 magnolia.bootstrapSync.repositories=config,website,users

 #set path of folder export to
 magnolia.bootstrapSync.config.exportPath=....path of folder to export to....
 magnolia.bootstrapSync.website.exportPath=....path of folder to export to....
 magnolia.bootstrapSync.users.exportPath=....path of folder to export to....

 #set root nodes to export: every change in this and subnodes will be
 #exported into a file likes [repository].[path.to.node].xml (ex. website.site.it.xml)
 #you can use * wildcards to avoid the export of subnodes files
 magnolia.bootstrapSync.config.exportRoots=/server/filters/servlets/*,\
  /server/filters/cms/*,\
  /server/filters/*,\
  /server/MIMEMapping/*,\
  /modules/templating/*/*/*,\
  /modules/*
 magnolia.bootstrapSync.website.exportRoots=/homepage,/help,/newsletter
 magnolia.bootstrapSync.users.exportRoots=/*

 #mgnl:content is the default nodeType, to change it:
 magnolia.bootstrapSync.users.nodeType=mgnl:user

Magnolia BootstrapSync is suggested to be used with a memory-only Apache Jackrabbit configuration, so that each developer can be easily keep its own magnolia repository syncronized with the bootstrap, making a store into xml files

magnolia.repositories.jackrabbit.config=WEB-INF/config/repo-conf/jackrabbit-memory-search.xml

    Project info & quick links