Welcome to ContentBox Modular CMS - Container Edition

ContentBox is a professional open source (Apache 2 License) modular content management engine that allows you to easily build websites, blogs, wikis, complex web applications and even power mobile or cloud applications with it's built in RESTFul services. Built with a secure and flexible modular core, designed to scale, and combined with world-class support, ContentBox can be deployed to any Java server or ColdFusion (CFML) server.

Tip: ContentBox is powered by the ColdBox HMVC Framework and Hibernate ORM.

Learn more about ContentBox at https://www.ortussolutions.com/products/contentbox and more about Docker deployment here: https://contentbox.ortusbooks.com/getting-started/installation/docker

Tags

We have our tags divided by either production or bleeding edge container images. Please choose wisely :muscle:

Production Tags

• :latest - The latest stable version of both ContentBox and our image
• :{imageVersion} - Specific ContentBox and Image Version ( e.g. :5.6.0 )
• :alpine - Latest stable version based off Alpine Linux
• :lucee5 - Latest stable version of this image with Lucee 5 warmed up
• :adobe2021 - Latest stable version of this image with Adobe 2018 warmed up
• :adobe2018 - Latest stable version of this image with Adobe 2018 warmed up
• :adobe2016 - Latest stable version of this image with Adobe 2016 warmed up

Development Tags

The following tags are based off our image's development branch. These are bleeding edge container images that we use for testing until they are promoted to production tags.

• :snapshot - Development version of this image
• :alpine-snapshot - Development version of this image based on Alpine Linux
• :lucee5-snapshot - Development version of this image with Lucee 5 warmed up
• :adobe2018-snapshot - Development version of this image with Adobe 2018 warmed up
• :adobe2021-snapshot - Development version of this image with Adobe 2021 warmed up
• :adobe2016-snapshot - Development version of this image with Adobe 2016 warmed up

Tip: Look in the tags section for other specific ContentBox versions

CommandBox Image Features

The ContentBox image is based on the CommandBox Image, so all features and environment variables are applicable. Please refer to that documentation as well: https://hub.docker.com/r/ortussolutions/commandbox/

Usage

This section assumes you are using the Official Docker Image
To deploy a new application, first pull the image (defaults to the latest tag):

docker pull ortussolutions/contentbox

The image is packaged with a self-contained EXPRESS version, which uses a very fast and portable in-memory H2 database engine. To get started just run:

docker run -p 8080:8080 \
	-e EXPRESS=true \
	-e INSTALL=true \
	ortussolutions/contentbox

Tip: The INSTALL flag tells the image to take you through the ContentBox installer to pre-seed a database. You can remove this flag once your database is seeded and persisted via a volume.

A new container will be spun up from the image and, upon opening your browser to http://[docker machine ip]:8080, you will be directed to configure your ContentBox installation wizard.

Persisting Data Between Restarts

The above run command produces an image which is self-contained, and would be destroyed when the container is stopped. If we wanted to run a version in production, we would need to persist, at the very minimum, the database and your custom assets \(widgets, modules, themes and media library\). In order to do this we need to mount those resources in to the Docker host file system.
By convention, the express H2 database is stored at /data/contentbox/db inside the container. In addition, the custom content module which contains your custom themes, widgets, modules and media library are stored under /app/modules_app/contentbox-custom.

Mountable Points

Mount Point	Description
/data/contentbox/db	The express H2 database
/app/modulesapp/contentbox-custom	The custom code module
/app/includes/shared/media	\\The legacy media location, use the custom modules location instead.

Let's mount both of those volume points, so that our database and user assets persists between restarts:

docker run -p 8080:8080 \
-e EXPRESS=true \
-e INSTALL=true \
-v `pwd`/contentbox-db:/data/contentbox/db \
-v `pwd`/contentbox-custom:/app/modules_app/contentbox-custom \
ortussolutions/contentbox

Now, once our image is up, we can walk through the initial configuration. Once configuration is complete, simply stop the container and then start it without the environment variable INSTALL in place. The H2 database and uploads will be persisted and the installer will be removed automatically on container start.

docker run -p 8080:8080 \
-e EXPRESS=true \
-v `pwd`/contentbox-db:/data/contentbox/db \
-v `pwd`/contentbox-custom:/app/modules_app/contentbox-custom \
ortussolutions/contentbox

INSTALL Setting Caveats

Please remember that the INSTALL environment variable is ONLY used to go through the ContentBox installer wizard. Once the database is seeded with the installation process, you will no longer use it unless you want to reconfigure the installation.

Custom Database Configuration

If you would like to connect your container to an external database system, you can very easily do so, which would allow us to connect from multiple containers in a distributed fashion \(MySQL, Oracle, MSSQL, etc\). If not, you run the risk of file locks if multiple container replicas are sharing the same H2 database.

Tip: We would suggest you use the H2 database or EXPRESS edition when using only 1 replica.

The image is configured to allow all ORM-supported JDBC drivers to be configured by specifying the environment variables to connect. Alternately, you may specify a CFCONFIG environment variable which points to file containing your engine configuration, including datasources.

By convention, the datasource name expected is simply named contentbox.

To programatically configure the database on container start, environment variables which represent your datasource configuration should be provided. There are two patterns supported:

1. DB_DRIVER configuration - which may be used for Adobe Coldfusion servers
2. DB_CLASS configuration - which configures a datasource by JDBC driver and connection string \(Both Adobe and Lucee\)

An example container run command, configuring a MySQL database would be executed like so:

docker run -p 8080:8080 \
-e 'INSTALL=true' \
-e 'CFCONFIG_ADMINPASSWORD=myS3cur3P455' \
-e "DB_CONNECTION_STRING=jdbc:mysql://mysqlhost:3306/contentbox_docker?useUnicode=true&characterEncoding=UTF-8&useLegacyDatetimeCode=true" \
-e 'DB_CLASS=org.gjt.mm.mysql.Driver' \
-e 'DB_USER=contentbox_user' \
-e 'DB_PASSWORD=myS3cur3P455' \
-v `pwd`/contentbox-custom:/app/modules_app/contentbox-custom \
ortussolutions/contentbox

To use the DB_DRIVER syntax for Adobe Coldfusion, an example run command would be:

docker run -p 8080:8080 \
-e 'CFENGINE=adobe@11' \
-e 'INSTALL=true' \
-e 'CFCONFIG_ADMINPASSWORD=myS3cur3P455' \
-e 'DB_DRIVER=MSSQLServer' \
-e 'DB_HOST=sqlserver_host' \
-e 'DB_PORT=1433' \
-e 'DB_NAME=contentbox_docker' \
-e 'DB_USER=sa' \
-e 'DB_PASSWORD=myS3cur3P455' \
-v `pwd`/contentbox-custom:/app/modules_app/contentbox-custom \
ortussolutions/contentbox

As you can see, these commands can become quite long. As such, using Docker Compose or CFConfig may provide a more manageable alternative.

Granular Environmental Control

A number of environment variables, specific to the ContentBox image, are availabe for use. They include:

• EXPRESS=true - Uses an H2, in-memory database. Useful for very small sites or for testing the image. See http://www.h2database.com/html/main.html
• INSTALL=true - Adds the installer module at runtime, to assist in configuring your installation. You would omit this from your run command, once your database has been configured
• CONTENTBOX_MIGRATE=true - Will perform a check and run any necessary contentbox version migrations prior to the startup of the container
• BE=true - Uses the bleeding edge snapshot of the ContentBox CMS, else we will defer to the latest stable version of ContentBox.
• HEALTHCHECK_URI - Specifies the URI endpoint for container health checks. By default, this is set http://127.0.0.1:${PORT}/ at 1 minute intervals with 5 retries and a timeout of 30s
• FWREINIT_PW - Allows you to specify the reinit password for the ColdBox framework
• SESSION_STORAGE - Allows the customization of session storage. Allows any valid this.sessionStorage value, available in Application.cfc. By default it will use the JDBC connection to store your sessions in your database of choice.
• DISTRIBUTED_CACHE - Allows you to specify a CacheBox cache region for distributing ContentBox content, flash messages, cache storage, RSS feeds, sitemaps and settings. There are only three cache regions defined in this image: default, template and jdbc. jdbc is the default cache that will distribute your data, default and template are in-memory caches. Please see the distributed caching section below to see how to register more caches.
• H2_DIR - Allows you to specify a custom directory path for your H2 database. By convention, this is set to /data/contentbox/db within the container
• contentbox_default_* - All Contentbox "Geek Settings" may be provided as environment variables, allowing granular control of your ContentBox settings.
• ORM_SECONDARY_CACHE - If true it will activate the ORM secondary cash to the ehcache provider. By default it is turned off.
• ORM_DIALECT - You can choose the specific ORM dialect if needed, if not we will try to auto-detect it for you.
• REMOVE_CBADMIN=false - If true then this image will not publish an Admin module, just the core, REST and UI modules.
• JVM_HEAPSIZE=512 - The amount in megabytes to assign the JVM running ContentBox. We default it to 512mb.

In addition, the CommandBox docker image environment variables are also available to use in your container. For additional information on using the CommandBox docker image, see the initial release blog entry.

Automatic Session Distribution

By default, the ContentBox image will use the Lucee Open Source CFML engine for running the application. It will also configure the datasource to store user sessions so you can easily scale the image or send it to Docker Swarm, Kubernetes, etc for scalability.
You can also use the SESSION_STORAGE environment variable to switch the connection to any backend you like.

Distributed Caching

By default, our image configures a jdbc CacheBox cache region that will be used to distribute settings, sessions, flash data, content, RSS feeds, sitemaps, etc. This means that out-of-the-box, your ContentBox containers can use the database to distribute its content within a swarm or set of services. However, if you would like to use your own CacheBox providers or a more sophisticated distributed cache like Redis or Couchbase, you can.
We have also prepared a docker compose and distribution example using Redis \(more caches to come\) and the ContentBox image. This example will allow you to have a stack that can easily distribute your sessions and content via Redis. You can find the repository in this repo under the folder: distributed-example

Healthchecks

The image contains built-in capabilities for healthchecks for the running application. You can customize the URL entry point by using the HEALTHCHECK_URI environment variable. By default, this is set http://127.0.0.1:${PORT}/ at 30s intervals with 15 retries and a timeout of 60s.

Issues

Please submit issues to our repository: https://github.com/Ortus-Solutions/docker-commandbox/issues

Building Locally + Contributing

You can use the following to build the image locally:

docker build --no-cache -f ./Dockerfile ./

You can test the image built correctly:

docker run -t -p 8080:8080 -e 'EXPRESS=true' -e 'INSTALL=true' [hash]

Once the hash is returned, you can use the following for publishing to the Ortus repos (If you have access)

docker tag [hash] ortussolutions/contentbox:5.6.0
docker tag ortussolutions/contentbox:5.6.0 ortussolutions/contentbox:latest
docker tag ortussolutions/contentbox:5.6.0 ortussolutions/contentbox:snapshot
docker push ortussolutions/contentbox