CI/CD documentation for the dotCMS Content Management System

The dotCMS source code includes an example CLI written in bash to demonstrate and simplify the interaction with our REST endpoints.

It allows you to quickly bootstrap an installation and create update ContentTypes, Sites, Folders, File Assets, Containers (as files) and Templates (as files).

You can find the cli code and an example here https://github.com/dotCMS/core/tree/master/tools/cli

Prerequisites

Download the cli source code

To download the code without checking out the whole dotCMS source tree, you can do something like:

git clone \
  --depth 1  \
  --filter=blob:none  \
  --sparse \
  https://github.com/dotcms/core ;
cd core
git sparse-checkout set tools/cli

This downloads the files needed to use the cli in the directory core/tools/cli. There is an example “bundle” you can use to test with under core/tools/cli/bundles/bike-shop. The examples below are based on this bundle.

Install jq

The dotCMS CLI relies on the command line tool jq which is a commonly used cli tool for json parsing.

Find a suitable version or the instructions to get it installed via package manager here.

Usage

The tool expects a directory like structure holding all the json descriptor/files to be pushed to dotCMS. The expected directory structure looks like this:

 /bundle
  |- /sites
      |- SYSTEM_HOST.site.json
      |- demo.dotcms.com.site.json
      / content-types
        |- blog.contentype.json
        |- story.contentype.json
      / files
          |- en-US 
          |   |- demo.dotcms.com (site)
          |   |  |- images (Folder)
          |   |  |  |- file1
          |   |  |  |- file2
          |   |  |- application (Folder)
          |   |     |- file3
          |   |     |- file4
          |   |
          |   |- authoring.dotcms.com
          |      |- images 
          |      |  |- file1
          |      |  |- file2
          |      |- application
          |         |- file3
          |         |- file4             
          |     
          |- es-CR 
             |- demo.dotcms.com (site)
                |- images 
                |  |- file1
                |  |- file2
                |- application
                   |- file3
                   |- file4

Usage

Config

Before you can use the tool you need to make it aware of the location of the dotCMS instance and also get a valid API Access Key associated with an authorized user. Here's how you can get a valid API Access Key. Once you have such information at hand. it must be set in the config file located in:

tools/cli/config    

The following properties are expected by the tool.

DOTCMS_BASE_URL
JSON_WEB_TOKEN
USER
PASS (Optional)

Special Json Files

Please notice that all content type files must end in .contentype.json. In a similar fashion site definition files must end in .site.json otherwise they will be ignored by the script.

Sites (*.site.json)

Here you can see a basic example that takes only one simple parameter Name, But you can pass much more.

Further info as to what can be done is available in our API-Site Resource.postman_collection.json Test

https://github.com/dotCMS/core/tree/master/dotCMS/src/curl-test/Site Resource.postman_collection.json

Content-Types (*.contentype.json)

The Content-Type Json files used by this script are the same definitions returned by our Content-Type API

Here are a few examples:

Important: The json returned by those endpoints must be slightly modified to fit the requirements of our API

Many of our read APIs wrap the main response body in an additional Entity property. Therefore the content type json body must be extracted from the entity property before putting it into a .contentype.json file

Another relevant detail is that content-type definition files must be fed with a valid site id. If not the content-type would be rejected.

We support pushing content-type file using site-name. Back in the server side the site-name will be resolved/
e.g.

   "fixed":false,
   "folder":"SYSTEM_FOLDER",
   "host":"my.cool-bike.com",
   "iDate":1623251909000,
   "id":"eab1ad11292a6052b90a6247b122858b"

if your bundle has a site named “my.cool-bike.com” that has been previously created such named can be used in you content-type files. But host can also be a regular valid site identifier or name. If the host is an empty string the CT will be placed under System-Host

Important: When a site-name gets passed to the Rest API. if the API fails to resolve the site-name. The new Content-Type will be placed under System-Host site as a fall-back and no errors will be reported on the logs by the app.

CLI Commands

Import bundles:

Takes a folder as parameter and it can be called by doing:

  ./dot-cli --bundle ../cli/bundles/bike-shop  

Basically this command takes care of loading the entire bundle into a remote instance of dotCMS

But if you want to do it piece by piece there are also some other options

Import files:

Also takes a folder as parameter and it can be called by doing:

./dot-cli --files ~/code/etc/bundle/files

This command imports the file assets piece of the directory structure described above.

Import sites:

Takes a file as parameter like this:

./dot-cli --site ../cli/bundles/bike-shop/sites/my.cool-bike.com.site.json

Important: Make sure your content-type file has valid site identifier set when using this command. As interpolation here is of no use.

Import Content-Types:

Takes a file as parameter like this:

./dot-cli --content-type ../cli/bundles/bike-shop/content-types/bike.contenttype.json