Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

In this tutorial:

Related topics:

This page explains how to install the Magnolia Community Edition (CE) bundle and an app to manage Eric's cars. We then build a website on that base.


Get Java

Magnolia needs a Java Runtime Environment (JRE). But you don't need Java skills to do this tutorial.

Type java -version in a terminal or command prompt. If the system reports a version number, Java is installed on your computer.

$ java -version
java version "10.0.1" 2018-04-17
Java(TM) SE Runtime Environment 18.3 (build 10.0.1+10)

If you don't have Java, install it:

Java is not pre-installed on Mac OS X 10.7 and later. Download the latest Java from Oracle.

On Windows you need a Java SE Development Kit (JDK). The Java Runtime Environment (JRE) is not enough because the Tomcat application server does not recognize it.

What is the difference?

  • JRE is for users who run Java programs on their computer.
  • JDK is for developers who write Java-based applications.

Download and install JDK. By default JDK is installed in C:\Program Files\Java\jdk-10.0.xx\. You can choose another location.

Check JAVA_HOME environment variable

  1. Open the command prompt.
  2. Type set and press ENTER.
  3. Find JAVA_HOME in the command output and verify that the path points to your JRE installation directory, for example  C:\Program Files\Java\jdk-10.0.xx .
  4. If JAVA_HOME is missing or it points to the wrong directory, see Set JAVA_HOME environment variable below.

Set JAVA_HOME environment variable

  1. Right-click My Computer and select Properties.
  2. Go to the Advanced tab. 
    (In Windows 7+, right-click Computer and select Advanced System Settings, then Environment variables.)
  3. If the JAVA_HOME environment variable does not exist in User variables or System variables, create it:
    • User variables apply to the currently signed-in user only. Create JAVA_HOME here if you want it to apply only to the currently logged in user. These variables take precedence over system variables.
    • System variables apply to all users. Create JAVA_HOME here if you want it to apply to all users. You must be an administrator to modify a system environment variable. 
  4. Set the value of JAVA_HOME to the path of your JDK installation directory, for example C:\Program Files\Java\jdk-10.0.xx.
  5. Optional step: Add the Magnolia bin directory to the PATH variable, for example C:\Program Files\magnolia\apache-tomcat-x.y\bin. Setting the PATH allows you to issue the Magnolia start and stop commands from anywhere without navigating to the installation directory first. Separate the path from existing paths with a semicolon ( ; ). If you do this, you also need to add CATALINA_HOME to environment variables. Set the value of CATALINA_HOME to the Tomcat installation directory, for example C:\Program Files\magnolia\apache-tomcat-x.y
  6. Click OK.
  7. Go back to Check JAVA_HOME environment variable above and test that the variable is found and has the correct value. You need to open a new command prompt since environment variables are session specific.

Alternatively you can set JAVA_HOME with a batch file. Add this line to /apache-tomcat/bin/magnolia_control.bat:

set JAVA_HOME=C:\Program Files\Java\jdk-10.0.1

The set command creates the JAVA_HOME environment variable and sets its value to the JDK directory. The command is executed when Magnolia starts.

Download the latest Java from Oracle. The installation directory varies from one Linux system to another. For example, on Ubuntu Linux 10 the OpenJDK Runtime Environment is installed in /usr/lib/jvm/java-10-openjdk/jre by default.

Download the latest Java from Oracle. You can install it in any directory such as /usr/java.

Download Magnolia

To start with the development, we recommend using a fresh ("vanilla") Magnolia CE bundle.

Extract the zip to your computer.


magnolia-x.y/
├── add-ons/
└── apache-tomcat-x.y/
    ├── bin/
    ├── conf/
    ├── lib/
    ├── logs/
    ├── temp/
    ├── webapps/
    |   ├── magnoliaAuthor/
    |   ├── magnoliaPublic/
    |   └── ROOT/
    └── work/

Where to extract:

Extract the zip to  /Applications  or another directory on your computer.
Extract the zip to C:\Users\<username>\magnolia or another directory on your computer.
If you are installing Magnolia for personal use extract the zip to /usr/home/<your account> or equivalent directory. If you are installing onto a production server extract the zip to /usr/local or /opt . A normal user account may not have permissions to extract files into a target directory such as /opt . If this is the case extract the zip in the folder where you downloaded it, open a terminal window, and move the extracted folder using sudo mv magnolia-x.y. The sudo command will execute the mv (move) command as superuser, prompting you for a password.
If you are installing Magnolia for personal use extract the zip to /usr/home/<your account> or equivalent directory. If you are installing onto a production server extract the zip to /usr/local or /opt . A normal user account may not have permissions to extract files into a target directory such as /opt . If this is the case extract the zip in the folder where you downloaded it, open a terminal window, and move the extracted folder using sudo mv magnolia-x.y. The sudo command will execute the mv (move) command as superuser, prompting you for a password.


Magnolia Community Edition software is distributed free-of-charge and without any warranty under the terms of the GNU General Public License (version 3), a license that permits you to redistribute and modify the software under certain terms and conditions. It is important that you read the license to understand your rights and obligations.

(warning) Don't start Magnolia yet.

Download a content app

You should use a content app to manage structured content. Content apps make it easy to manage items such as products, or in our case cars.

* magnolia-app-tutorial-1.4.8.jar

Add the jar file in the $<your-magnolia-installation>/apache-tomcat-x.y/webapps/magnoliaAuthor/WEB-INF/lib folder.

Note: We are reusing a content app that was created in another tutorial: My first content app. If you are interested in creating your own content app do that tutorial later.

Start Magnolia

  1. Open a terminal, go to the magnolia-x.y/apache-tomcat-x.y/bin directory, and type:

    ./magnolia_control.sh start

    In a successful startup the last line printed to the terminal reads: INFO: Server startup in 12345 ms.

  2. Open a browser and go to http://localhost:8080

Detailed instructions:

  1. Open a terminal window in Applications > Utilities > Terminal.

  2. Go to the Magnolia installation directory

    cd /Applications/magnolia-x.y/apache-tomcat/bin

  3. Start Magnolia.

    ./magnolia_control.sh start &amp;&amp; tail -f ../logs/catalina.out

The first part of the startup command ./magnolia_control.sh start launches Magnolia. The second part && tail -f ../logs/catalina.out displays log messages written to /apache-tomcat/logs/catalina.out log file. This makes it easier to troubleshoot startup errors.Magnolia reports startup information. If startup fails, look for the reason in the report. In a successful startup the last line reads: INFO: Server startup in 12345 ms.

To stop Magnolia, type CTRL + C, then ./magnolia_control.sh stop and press RETURN.
  1. Open a command prompt and go to the Magnolia installation directory. 
    (To do this, type cd C:\Users\<username>\magnolia-x.y\apache-tomcat\bin)
  2. Type magnolia_control.bat start and press ENTER.
    Magnolia reports startup information in a new Tomcat window. If startup fails, look for the reason in the report. In a successful startup the last line reads: INFO: Server startup in 12345 ms
To stop Magnolia, type CTRL + C , then ./magnolia_control.sh stop and press ENTER.
  1. Open a terminal window.
  2. Go to the Magnolia installation directory: 
    cd /home/<your account>/magnolia-x.y/apache-tomcat/bin 
    Your path may be different.
  3. Start Magnolia: 
    ./magnolia_control.sh start && tail -f ../logs/catalina.out

The first part of the startup command ./magnolia_control.sh start launches Magnolia. The second part && tail -f ../logs/catalina.out displays log messages written to /apache-tomcat/logs/catalina.out log file. This makes it easier to troubleshoot startup errors.Magnolia reports startup information. If startup fails, look for the reason in the report. In a successful startup the last line reads: INFO: Server startup in 12345 ms

To stop Magnolia, type CTRL + C , then ./magnolia_control.sh stop and press ENTER.
  1. Open a terminal window.
  2. Go to the Magnolia installation directory: 
    cd /home/userAccount/magnolia-x.y/apache-tomcat/bin 
    Your path may be different.
  3. Start Magnolia: 
    ./magnolia_control.sh start && tail -f ../logs/catalina.out

The first part of the startup command ./magnolia_control.sh start launches Magnolia. The second part && tail -f ../logs/catalina.out displays log messages written to /apache-tomcat/logs/catalina.out log file. This makes it easier to troubleshoot startup errors.Magnolia reports startup information. If startup fails, look for the reason in the report. In a successful startup the last line reads: INFO: Server startup in 12345 ms

To stop Magnolia, type CTRL + C , then ./magnolia_control.sh stop and press ENTER.

Install Magnolia

To install Magnolia:
  1. Open a browser and go to http://localhost:8080
  2. Click Run the Web update on the author instance, then Start installation.
  3. Click Run the Web update on the public instance, then Start installation.


Magnolia installs its modules. When the installation is complete on the author and public instances, click Start up Magnolia on both:

Log in

Go to  http://localhost:8080/magnoliaAuthor/.magnolia/admincentral  and sign in as:

  • Username: superuser
  • Password: superuser

Add a car

Open the Products app installed by the app-tutorial module and get familiar with it. 

Since the items in the app are cars let's talk about cars from now on. Try the tree, list and thumbnail views. Add a car of your own.

   


Next: Creating a light module