In case you don't want to go through the full installation procedure for a test drive, you can also use our read-to-run Docker image available from the Docker Hub at https://hub.docker.com/r/alkacon/opencms-docker.
All installation parts are described as single steps. After completing each step you are strongly advised to verify the success of your work.
- Install the Java SDK, version 7 or newer
- Install Tomcat
- Install MySQL
- Deploy the
- Install OpenCms using the Setup-Wizard
- Now your system is ready
- Security issues
Install the Java JDK, version 7 or newer (from Oracle
http://www.oracle.com/technetwork/java/javase/downloads/index.html). 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!
OpenCms requires a Servlet 2.4 / JSP 2.0 standards compliant container. This release was tested with Tomcat 7.0.x. and Tomcat 8.0.x.
Install Tomcat from
http://tomcat.apache.org into a folder of your choice. This is the
CATALINA_HOME folder. Don't forget to set the environment variables
Test the installation by running Tomcat in standalone mode and check the examples. Note: Tomcat uses port 8080 in standalone mode. If you wish, you can combine the servlet-engine with a webserver like the Apache Web Server
http://httpd.apache.org. Please see the documentation available with the webserver on how to combine it with your servlet environment.
Please note: On Linux systems, Tomcat's JVM has to be started with the command line argument
Install MySQL from
http://www.mysql.com/downloads/ (see the MySQL documentation on
http://www.mysql.com/documentation/index.html). On Windows-based systems MySQL has to be installed on the
C:\ drive and should be registered as service using
OpenCms can be used with MySQL 5.0, 5.1 and 5.5.
Start the MySQL server by running the service (WIN32) or executing
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.
Important: 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.
opencms.war file from the binary distribution ZIP file to
CATALINA_HOME with the real path to your Tomcat installation.
Start (or restart) Tomcat. Tomcat will now deploy the web application OpenCms.
Important: OpenCms requires that it's
*.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 containers / 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
Start the Setup-Wizard by pointing your webbrowser 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.
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:
Finally after you have installed OpenCms you should have a look at the security settings.
First change the
Admin user password of OpenCms by calling the user preferences (the "checkbox" icon in the top menu on the main screen of the Workplace).
Then you can add a password to the MySQL database. Enter the following commands at the MySQL command line.
insert into user values ('localhost', 'opencmsuser', password('XXXXX'),\
insert into db values ('localhost', 'opencms', 'opencmsuser',\
Make sure you replace
opencms with the name of your user and database in case you have changed them on the setup wizard.
Don't forget to add the new user and password to all connect strings of the database in your
opencms.properties file. Only the new user can now connect to the OpenCms tables. For more information see the MySQL documentation.