Skip to content

Latest commit

 

History

History
182 lines (122 loc) · 7.63 KB

README.md

File metadata and controls

182 lines (122 loc) · 7.63 KB
Raw

OpenCms logo

Official OpenCms Docker Image

Welcome to the official OpenCms Docker image maintained by Alkacon.

Here you find a Docker Compose setup with a ready to use OpenCms installation including Jetty and MariaDB.

OpenCms can be used with other databases and Servlet containers as described in the OpenCms documentation.

Available tags

Images for older OpenCms versions are also available, see here.

How to use this image

Step 1: docker-compose.yml

Save the following docker-compose.yml file to your host machine.

services:
    mariadb:
        image: mariadb:latest
        container_name: mariadb
        init: true
        restart: always
        volumes:
            - ~/dockermount/opencms-docker-mysql:/var/lib/mysql
        environment:
            - "MYSQL_ROOT_PASSWORD=secretDBpassword"
    opencms:
        image: alkacon/opencms-docker:18.0
        container_name: opencms
        init: true
        restart: always
        depends_on: [ "mariadb" ]
        links:
            - "mariadb:mysql"
        ports:
            - "80:8080"
        volumes:
            # Up to image 16.0: ~/dockermount/opencms-docker-webapps:/usr/local/tomcat/webapps
            - ~/dockermount/opencms-docker-webapps:/container/webapps
        command: ["/root/wait-for.sh", "mysql:3306", "-t", "30", "--", "/root/opencms-run.sh"]
        environment:
             - "DB_PASSWD=secretDBpassword"

Change the MariaDB root password secretDBpassword.

Step 2: Persist data

Adjust the following directories for your host system:

  • ~/dockermount/opencms-docker-mysql the directory where all MariaDB data are persisted
  • ~/dockermount/opencms-docker-webapps the Tomcat webapps directory that contains important configurations, caches and indices of OpenCms

Configured in this way, it is possible to upgrade the opencms and mariadb containers while keeping all your OpenCms and MariaDB data. See the upgrade guide below.

On the other hand, if you like to start with a completely fresh OpenCms installation, do not forget to delete both mounted directories before.

Step 3: Start OpenCms and MariaDB

Navigate to the folder with the docker-compose.yml file and execute docker-compose up -d.

Startup will take a while since numerous modules are installed.

You can follow the installation process with docker-compose logs -f opencms.

Step 4: Login to OpenCms

When the containers are set up, you can access OpenCms via http://localhost/system/login.

The default account is user name Admin with password admin.

Environment variables

In addition to DB_PASSWD, the following Docker Compose environment variables are honored:

  • DB_HOST, the database host name, defaults to mysql
  • DB_USER, the database user, default is root
  • DB_PASSWD, the database password, is not set by default
  • DB_NAME, the database name, default is opencms
  • ADMIN_PASSWD, the admin password, defaults to admin
  • OPENCMS_COMPONENTS, the OpenCms components to install, default is workplace,demo; to not install the demo template use workplace
  • JETTY_OPTS, the Jetty startup options (in addition to predefined options), default is -Xmx2g
  • DEBUG, flag indicating whether to enable verbose debug logging and allowing connections via {docker ip address}:8000, defaults to false
  • JSONAPI, flag indicating whether to enable the JSON API, default is false
  • SERVER_URL, the server URL, default is http://localhost

Upgrade the image

Make sure that you have persisted your OpenCms data and MariaDB data with Docker volumes as described above. Otherwise you will lose your data.

If you have installed OpenCms 17.0 and want to upgrade to OpenCms 18.0, proceed as follows:

Enter the target version of the OpenCms image in your docker-compose.yml file.

    opencms:
        image: alkacon/opencms-docker:18.0

If you update from 16.0, additionally adjust the volume for the opencms service in your docker-compose.yml file:

    {your mount point}:/usr/local/tomcat/webapps -> {your mount point}:/container/webapps

Navigate to the folder with the docker-compose.yml file and execute docker-compose up -d.

During startup, the Docker setup will update several modules as well as JAR files and configurations in the /container/webapps directory.

You can follow the installation process with docker compose logs -f opencms.

When upgrading to OpenCms 18.0 it is strongly recommended to remove the folder WEB-INF/index after the upgrade and recreate the indexes after the upgrade since the Solr version is updated.

Connecting to different database management systems / Custom setup properties

You can use the image to install against other DBMS than MariaDB by providing a custom setup properties file.

The file has to be mounted as volume to the container directly in the root folder as /custom-setup.properties.

If you the custom file, the setup relevant environment variables DB_HOST, DB_USER, DB_PASSWD, DB_NAME, OPENCMS_COMPONENTS, SERVER_URL will simply be ignored.

An example configuration is found under compose/postgres/docker-compose.yml.

NOTE: The feature is experimental.

Building the image

Since the image is available on Docker Hub, you do not need to build it yourself. If you want to build it anyway, here's how to do it:

Download the opencms-docker repository.

Go to the repository's main folder and type docker compose build opencms.

Image variant with Tomcat

Up to OpenCms 16.0 the image used Tomcat as servlet container. For OpenCms 17.0 and later it is still possible to use Tomcat, but the image is not provided on Docker Hub.

You can build the image using the compose file under compose/build-tomcat/docker-compose.yml.

Running it, the environment variable JETTY_OPTS is ignored, but the following two variables can be set:

  • TOMCAT_OPTS, the Tomcat startup options, default is -Xmx2g -Xms512m -server
  • WEBRESOURCES_CACHE_SIZE, the size of tomcat's resources cache, default is 200000 (200MB)

Image History

We list only changes relevant for building the image.

OpenCms 17.0

  • Switch from Tomcat to Jetty
  • Environment variable GZIP removed (enabled by default)
  • Environment variable ENABLE_JLAN removed (JLAN is disabled, use WebDAV to mount the VFS)
  • webapps folder is now located under /container/, before it was /usr/local/tomcat/
  • Support for custom setup properties was added
  • Docker compose files for image variations are added

License

View the licence information on GitHub.