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.
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.
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.
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!
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 Setup Wizard
Step 1: License agreement
Step 3: Database settings
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
If you later want to change your database connection settings, you can do this in the
The database setting options in the dialog slightly differs depending on which database product is selected.
Step 4: Module Selection
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 6: Server Settings
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.