OpenCms Documentation

Getting Started

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

Welcome to the OpenCms getting started guide. On this page you will learn how to:

  • Install OpenCms
  • Try the basic content management features of OpenCms

You can install OpenCms along with the OpenCms Mercury demo. Mercury is the standard template of OpenCms—a feature-rich, modular template and the Mercury demo presents what is possible with OpenCms.

Installing OpenCms

You can install OpenCms with Docker or manually.

Docker based Installation

The easiest way to install OpenCms is to use our official docker image. See alkacon/opencms-docker on Docker Hub for full information about running the OpenCms docker image.

The docker setup already includes a pre-configured MariaDB database and a Tomcat server, which you need to run OpenCms.

Manual Installation

You can install OpenCms "from scratch" manually on your local PC or on your server. See the OpenCms installation guide for full information about manually installing OpenCms.

Part of the manual installation process is the setup wizard which is described in more detail below.

Chapter server installation in this documentation offers additional hints about installing OpenCms on a production server.

Trying OpenCms

In order to try OpenCms, use your local installation or the live demo server.

Live Demo Server

If you want to try OpenCms with Mercury, the easiest option is to use the OpenCms Live Demo server.

The live demo provides a personal OpenCms installation exclusively for you. All you need to do is register with a valid email address.

We will not use the data you provide for anything else than setting up your personal demo installation!

Local Installation

If you want to try OpenCms locally, be it with a Docker installation or a manual installation, make sure to install the demo component modules.

The demo modules offer a tutorial about basic content editing features such as modifing pages, edit contents, work with the sitemap editor and the explorer, and publish changes.

The Setup Wizard

The setup wizard is part of the manual installation of OpenCms if you did not choose the Docker setup.

Step 1: License agreement

Fig. [setup-wizard-license-agreement]: Licence Agreement in the Setup Wizard

Step 2: System check

Fig. [setup-wizard-system-check]: System Check of the Setup Wizard

Step 3: Database settings

Fig. [setup-wizard-database-settings]: Database Settings of the Setup Wizard

Please note the difference between Setup connection and OpenCms connection:

The setup connection, as the name suggests, is only used during setup, or more precicely, to initially create the database tables and the database schema for OpenCms. The setup connection needs full permissions for the database. The credentials are not persisted anywhere but discarded after setup completion.

The OpenCms connection is used for all database operations during livetime of your OpenCms installation, e.g., to read and write content data or to import modules. This connection does not need full permissions for the configured database but only read and write permissions.

The OpenCms connection is persisted in the opencms.properties file to be found in the Tomcat directory {CATALINA_HOME}/webapps/<OPENCMS>/config/.

If you later want to change your database connection settings, you can do this in the opencms.properties file.

The database setting options in the dialog slightly differs depending on which database product is selected.

Step 4: Module Selection

Fig. [setup-wizard-module-selection]: Module Selection of the Setup Wizard

The OpenCms workplace is required for a full OpenCms installation. The only situation where you might want to de-select the workplace modules is for a cluster installation with replication. In a cluster replication setup, only the redactory server needs the workplace modules installed but not the replicated publication servers.

If you want to try OpenCms, make sure to select the demo template modules.

Step 5: Module Import

Fig. [setup-wizard-module-import]: Module Import of the Setup Wizard

Step 6: Server Settings

Fig. [setup-wizard-server-settings]: Server Settings of the Setup Wizard

The server settings are again only relevant for a cluster installation. In a cluster setup, the redactory server and each publication server configures an individual Server ID, a Server URL, and an ethernet address.

For a standard OpenCms installation with one server for content edition and content publication, you can leave the values as is.

Step 7: Final Notes

Fig. [setup-wizard-final-notes]: Final Notes of the Setup Wizard