Creating a custom bundle

A bundle is a package consisting of a Magnolia webapp and a selection of modules. Each bundle has a particular purpose such as demonstration or production use. In this tutorial you create your own bundle. Select only the modules the project needs, not more. A small purpose-built bundle is easy to understand and fast to build and deploy. Maven handles the dependencies between modules.  

Bundles provided by Magnolia

Magnolia provides a number of ready-made bundles. For more information please read bundles and webapps.

 Click here to expand to see the list of preconfigured Magnolia bundles

Magnolia provides the following stand-alone, pre-configured Apache Tomcat server that does not include a webapp:

Artifact	Usage / purpose
magnolia-tomcat-barebone	A preconfigured Tomcat server ready to be used together with any Magnolia webapp.

Magnolia provides the following webapps and bundles.

Artifact					Usage	Module summary1
Cloud edition
magnolia-cloud-webapp					The standard Magnolia cloud offer bundles a selection of enterprise-level modules, including connectors enabling you to integrate third-party systems, tools and data sources.	See Supported modules in the cloud.
magnolia-cloud-dev-webapp					Enterprise level webapp specifically built for testing Magnolia Cloud development work locally.	See Supported modules in the cloud .
magnolia-cloud-headless-webapp					Bundles a lighter selection of enterprise-level modules enabling you to create content and use it in headless deployment scenarios.	See Supported modules in the cloud - Headless cloud bundle modules .
Community edition
magnolia-empty-webapp					This is the most basic Magnolia webapp. Use this as a base for custom tailored webapp.	Core modules from main and ui, Cache (core and ehcache), Pages, Resources, Publishing, Security and Scheduler.
magnolia-community-webapp					Complete Magnolia community edition webapp; no demo project.	Same as magnolia-empty-webapp plus: Cache tools,  Cache Browser, Categorization, Commenting, Contacts, DAM, Form , Google sitemap, Groovy, Mail, Messages, MTE , REST and Site.
magnolia-community-demo-webapp					Same as magnolia-community-webapp plus the travel demo	Travel demo community edition 2
magnolia-community-demo-bundle					Tomcat-bundle including magnolia-bundled-webapp and travel demo	Travel demo community edition 2
Enterprise Standard edition
magnolia‑enterprise‑standard‑webapp					Same as magnolia-community-webapp plus Enterprise Standard modules; no demo	Backup, Content Dependencies, Content Translation Support, Diff, Google Analytics, Marketing Tags, Personalization, Privacy module Publishing Transactional, Soft Locking and Workflow.
magnolia‑enterprise‑standard‑demo‑webapp					Same as magnolia‑enterprise‑standard‑webapp plus the travel demo	Travel demo Enterprise Standard edition 3
Enterprise Pro edition
magnolia-enterprise-pro-webapp					magnolia-enterprise-standard-webapp plus Enterprise Pro module(s); no demo	Backup, Content Dependencies, Content Editor, Content tagging, Content Translation Support, Diff, Google Analytics, Marketing Tags, Personalization, Privacy module Publishing Transactional, Soft Locking, Workflow and Multisite.
magnolia-enterprise-pro-demo-webapp					magnolia-enterprise-pro-webapp plus the travel demo	Travel demo enterprise pro edition 4
magnolia-enterprise-pro-demo-bundle					Tomcat bundle with magnolia-enterprise-webapp including travel demo	Travel demo Enterprise Pro edition 4
magnolia-enterprise-installer					Installer for magnolia-enterprise-pro-demo-bundle
magnolia-enterprise-weblogic-webapp		5			Webapp based on magnolia-enterprise-webapp including travel demo; tuned for Weblogic without workflow 5	Travel demo Enterprise Pro edition 4
magnolia-enterprise-websphere-webapp		5			Webapp based on magnolia-enterprise-webapp including travel demo; tuned for Websphere without workflow 5	Travel demo Enterprise Pro edition 4

(1) The module summary does not list all modules but provides a good summary. To get the complete list of the modules, look at the corresponding pom file of the bundle.
(2) Travel demo Community edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours.
(3) Travel demo Enterprise Standard edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours, magnolia-travel-demo-personalization, magnolia-travel-demo-marketing-tags.
(4) Travel demo Enterprise Pro edition contains the following modules: magnolia-travel-demo, magnolia-travel-tours, magnolia-travel-demo-personalization, magnolia-travel-demo-marketing-tags, magnolia-travel-demo-multisite.
(5) Both magnolia-enterprise-weblogic-webapp and magnolia-enterprise-websphere-webapp contain all Enterprise Standard and Pro modules but not those for workflow.

Downloads

• Magnolia Community webapps and bundles
• Magnolia DX Core webapps and bundles

Tools

In this tutorial we use:

• Maven: You should be familiar with the Maven dependency mechanism. The same concept applies to other dependency management and build tools such as Ant+Ivy or Gradle. See Maven setup if you are new to Maven or want to install it in order get access to Magnolia resources from Magnolia Nexus.
• IDE: The examples and screenshots are from IntelliJ IDEA but any Java IDE such as Eclipse or Netbeans works. If you work with a different tool and would like to contribute steps, leave a comment.
• Terminal or command line: Some commands in this tutorial are Mac OS X specific. Replace them with equivalent commands on your operating system.

Create an empty project

1. Open a terminal and go to a directory where you keep your Magnolia projects.

   cd ~/development/magnolia

2. Generate a new project from a Maven archetype:
   

   mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=https://nexus.magnolia-cms.com/content/groups/public/ 

3. Choose the magnolia-project-archetype from the options Maven presents.
4. Provide the project information. Press ENTER to accept the default.
   
   • Version: Choose the latest version provided.
   • Group ID: example.com or a group ID that reflects your company.
   • Artifact ID: example-project or an artifact ID that reflects your project.
   • Version: 1.0-SNAPSHOT
   • Package: example.com. Maven proposes a package name based on the group ID. You can change it later in configuration.
   • magnolia-bundle-version: Find the latest Magnolia bundle version in Releases.
   • Project name: example-com. Maven proposes a package name based on the group ID. You can change it later in configuration.

5. Verify your input and accept with Y:

   Confirm properties configuration:
   groupId: com.example
   artifactId: example-project
   version: 1.0-SNAPSHOT
   package: com.example
   magnolia-bundle-version: 5.6.6
   project-name: example-project

Maven creates an empty project structure in the current directory.

Project structure:

• example-project: Parent project.
  
  • example-project-webapp: Your custom bundle as a child Maven project. Here you find a typical Magnolia project folder structure.
    
    • pom.xml: Webapp project POM.
    • src: Java source code and project configuration
  • pom.xml: Parent POM.

Build the project

Go to the project folder that Maven created:

cd example-project

Build the project:

mvn clean install

Run the project

Open the project in your IDE. These instructions are for IntelliJ IDEA. Adapt for other IDEs.

1. In IDEA, go to File > Import project > Browse to the parent project pom.xml.
2. Go to Run > Edit Configurations > + > Tomcat Server > Local.
   
3. Go to the Deployment tab and add an artifact example-project-webapp:war exploded.
   
4. Set Application Context to root (/). You can deploy the application to a different context if you like.
5. Start the project.

The Tomcat application server starts and deploys the Magnolia project. If your IDE does not open a Web browser automatically, go to http://localhost:8080/ .

Install Magnolia and log in

Start Magnolia installation.

Note: The screenshot above is outdated showing installation tasks when using Magnolia 5.3.6. We recommend always using the latest stable Magnolia version when creating a new custom bundle.

Log in:

• Username: superuser
• Password: superuser

You are now running a basic Magnolia project with an empty webapp.

Add modules

If the magnolia-empty-webapp runs without errors, the project is ready to add modules according to your requirements. In this example we add the REST modules.

Look at the parent project pom.xml file in example-project/pom.xml. It uses Maven's dependency management mechanism to import dependencies from the ce-bundle. (Search for the commented note "Importing dependencyManagement of CE bundle".) 

When you add modules to your example-project-webapp you don't have to specify their versions. Version numbers are inherited from the dependency-management section of the ce-bundle. You only need to specify the version in example-project/example-project-webapp/pom.xml - if you want to override the versions defined in the dependency management of the ce-bundle.

As an example, add the REST modules to your project. Add the following code in the dependencies section of the webapp pom in example-project/example-project-webapp/pom.xml:

<dependency>
  <groupId>info.magnolia.rest</groupId>
  <artifactId>magnolia-rest-integration</artifactId>
</dependency>
<dependency>
  <groupId>info.magnolia.rest</groupId>
  <artifactId>magnolia-rest-services</artifactId>
</dependency>
<dependency>
  <groupId>info.magnolia.rest</groupId>
  <artifactId>magnolia-rest-content-delivery</artifactId>
</dependency>

 IntelliJ IDEA displays a notification when you modify a POM file. It prompts you to “Import Changes” or “Enable Auto-Import”. Enabling auto-import works quite well but can be resource intensive if you modify POM files heavily. In this example you can enable auto-import. If you choose not to, remember to click “Import Changes” at least once before starting up the server.

Restart your server for the new modules to be picked up. Magnolia asks you to install the REST modules. After installation you can find a new app in the Dev group and you can start the REST Tools app.

Conclusion

In this tutorial you learned how to create a Magnolia project from a Maven archetype, built the project with Maven, and added custom modules. The project does not do much yet but you reached important goals already:

• You built your own project with Magnolia. You did not need to manually “drop a jar” in the Web application or modify a configuration file in the deployed webapp.
• The build is reproducible. You can check your files into a source control system. Based on the files your team mates or a continuous integration server can reproduce the build any time. They can also release your project.

Credits:

• Gregory Joseph: Don't Build Magnolia, Build Your Projects