OpenCms Documentation

Getting OpenCms

 Show GitHub edit links  Hide GitHub edit links
Documented since: 9.5 Latest revision for: 9.5 Valid for OpenCms: 12.0

Try OpenCms now. We explain where you can download the latest OpenCms version and how to install OpenCms locally. We will not cover an installation on a production server. But you can develop your website locally and move to a server whenever you want. OpenCms makes it easy to move between different installations.

Why should I install OpenCms locally?

  • You can log in to your local installation and play with it.
  • OpenCms provides a feature-rich demo that you can explore and adapt.
  • This documentation can be installed locally and you can try the interactive demos in your local installation.
  • It is not hard to move your generated content to other OpenCms installations, so you can use the local installation and start developing your own web site.

How to install OpenCms on your production web server? - Look it up here.

Using the docker image

The easist way to play with OpenCms is to use the offical docker image.

Manual installation

If you do not like to use the docker image, you can install OpenCms manually on your local machine as well.

Where to download OpenCms?

OpenCms is free. You can download the latest stable release at Extract the downloaded file It will contain a file opencms.war, that you need later on in the installation process.

What do I need to run OpenCms locally?

To use OpenCms you need

  • a JDK (Java Development Kit)
  • a servlet container (e.g., Tomcat)
  • a DBMS (e.g., MySql).

Here, you get a tutorial on how to install the JDK, MySql and Tomcat, and how to deploy and set up OpenCms. We recommend this installation, but of course you are free to choose other components to run OpenCms.

Installation guide

The guide assumes you already downloaded OpenCms.

Install the Java SDK, version 8 or newer

Install the Java JDK, version 8 or newer (from Oracle For details on how to install these components on your operating system, see the documentation that comes with them. You must install the Java JDK (Java Development Kit), not the JRE (Java Runtime Environment) that is also available from Oracle. The JRE is not sufficient to run OpenCms!

Install Tomcat

OpenCms requires a Servlet 3.1 / JSP 2.3 standards compliant container. This release was tested with Tomcat 8.0.x. and Tomcat 8.5.x and Tomcat 9.0.x.

Install Tomcat from into a folder of your choice. This is the CATALINA_HOME folder. Don't forget to set the environment variables CATALINA_HOME and JAVA_HOME.

Test the installation by running Tomcat in standalone mode and check the examples. Note: Tomcat uses port 8080 in standalone mode.

On Linux systems, Tomcat's JVM has to be started with the command line argument -Djava.awt.headless=true.

Install MySQL

Install the "MySQL Community Server" from (see under "MySQLCommunity edition" for the free version).

OpenCms can be used with MySQL >= 5.5.

Start the MySQL server by running the service (WINDOWS) or executing %MYSQL_HOME%/bin/mysqld (UNIX).

Check that MySQL is running before you continue by starting the MySQL monitor (execute mysql in your MySQL bin folder). The database works correctly if a MySQL prompt appears after calling the monitor. Quit the MySQL monitor by typing exit and go to the next step.

You will have to increase the MySQL configuration variable max_allowed_packet located in the MySQL configuration file (usually called my.ini). For OpenCms, the limit should be as high as possible, a setting of at least max_allowed_packet=32M is recommended.

Deploy the opencms.war file

Copy the opencms.war file from the binary distribution ZIP file to CATALINA_HOME/webapps/. Replace CATALINA_HOME with the real path to your Tomcat installation.

Start (or restart) Tomcat. Tomcat will now deploy the web application OpenCms.

OpenCms requires that its *.war file is unpacked. OpenCms can not be deployed as war file only. Make sure Tomcat does unpack the war file and creates the CATALINA_HOME/webapps/opencms/ directory, placing the OpenCms files in this directory. The default configuration for your Servlet container's / environment could be to not unpack the deployed *.war file. If this is so, you must unpack the opencms.war file manually. Use an unzip tool for this: *.war files are just *.zip files with a different extension. The OpenCms setup wizard will display a warning and not allow you to continue if you did not unpack the *.war file.

Install OpenCms using the Setup-Wizard

Start the Setup-Wizard by pointing your web browser to http://localhost:8080/opencms/setup/. Depending on your configuration, you have to replace localhost with your servername. The port 8080 is only used if you start Tomcat in standalone mode.

Follow the instructions of the OpenCms Setup-Wizard. It will set up the OpenCms database and import all available modules into the system. For normal installations with MySql and Tomcat running on the same server, all default settings will fit your needs. If you are using different database users, be sure that they exist before creating the database tables and importing the modules.

Make sure you disable all popup blockers and enable Javascript for the server URL you installed OpenCms on. Otherwise you will not be able to log in to the OpenCms Workplace.

Now your system is ready

Now your system is ready to use. You can login with username: Admin and password: admin. Please change this password as soon as possible. The login URL of OpenCms in a default configuration is: http://localhost:8080/opencms/system/login/.

You can improve this page

Please contribute your suggestions or comments regarding this topic on our wiki. For support questions, please use the OpenCms mailing list or go for professional support.