Magnolia Quickstart With JBoss

Document Overview

This page will give you the steps needed to get Magnolia running with JBoss.  If you would like more details into what each step does or how it works, please see : Understanding JBoss With Magnolia.

1 - Determine Which JBoss Version To Use

2 - Determine Which Java Version To Use

WildFly 10 and above requires Java SE 8. It will not run with Java SE 6, Java SE 7 or 9.⁽¹⁾⁽²⁾

3 - Verify With Magnolia’s Certified Stack

Verify with Magnolia’s certified stack to ensure that the Java version is also compatible with the Magnolia version you wish to use: Magnolia Certified Stack.

4 - Download JBoss

Versions Below JBoss EAP 7.0 / JBoss AS

Click here: https://jbossas.jboss.org/downloads

Download the ZIP file with the description saying “Java EE Full & Web Distribution”.

Versions With JBoss EAP 7.0 and Above

Click here:  https://wildfly.org/downloads/ 

Download the ZIP file with the description saying “Java EE Full & Web Distribution”

5 - Add Magnolia to JBoss

 - Unzip the file you downloaded and create a new folder within the "standalone/deployments" folder. Name this folder “<name_of_Magnolia_instance>.war”. This is a regular folder and it will not be a WAR file, we will just be having “.war” as part of the name. 

 - Drop the Magnolia WAR file into this newly created folder.

 - Explode the added WAR file: How to Explode a WAR.

6 - Configure Magnolia With JBoss

- Within standalone/deployments/<name_of_Magnolia_instance>.war/WEB-INF folder, create a new file and name it “jboss-deployment-structure.xml”. 

- Paste the following code into this newly created file:

<?xml version="1.0"?>
<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <exclude-subsystems>
            <subsystem name="weld" />
            <subsystem name="jaxrs" />
            <subsystem name="webservices" />
        </exclude-subsystems>
        <exclusions>
            <module name="org.apache.log4j" />
            <module name="org.slf4j" />
            <module name="org.bouncycastle" />
        </exclusions>
    </deployment>
</jboss-deployment-structure>

 - Open your magnolia.properties file and add the following line : magnolia.definitions.classpath=info.magnolia

7 - Deploy Your Magnolia Instance

Create a new file within standalone/deployments and name it “<name_of_folder_with_exploded_WAR>.dodeploy”. As an example, if you named the folder magnoliaAuthor.war, the name of this new file will be “magnoliaAuthor.war.dodeploy”. No other changes will be made to this file.

8 - Start The Server

Open a console window and change directory to “<JBoss_folder>/bin”. And execute the following command: ./standalone.sh

9 - Access The Page

The page name is the name of the folder you created. 

10 - Stop The Server

You can shut off the server by doing ctrl+c on the console that you started the server with.