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
Where to download OpenCms?
OpenCms is free. You can download the latest stable release at http://www.opencms.org/en/download/. Extract the downloaded file
opencms.zip. 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.
Install the Java SDK, version 8 or newer
Install the Java JDK, version 8 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 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
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.
Install the "MySQL Community Server" from
http://www.mysql.com/downloads/ (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
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.
max_allowed_packetlocated in the MySQL configuration file (usually called
my.ini). For OpenCms, the limit should be as high as possible, a setting of at least
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.
*.warfile 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
*.warfile. If this is so, you must unpack the opencms.war file manually. Use an unzip tool for this:
*.warfiles are just
*.zipfiles with a different extension. The OpenCms setup wizard will display a warning and not allow you to continue if you did not unpack the
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.