Configuring and Building the Workspace

Last updated a day ago

Learn how to configure and build the workspace

LightbulbWhat you'll learn

  • Setting up your development system
  • Getting the Blueprint workspace and licences
  • Building the Blueprint workspace

Person reading a bookPrerequisites

  • Development experience

WristwatchTime matters

Reading time: 15 to 20 minutes

Person in front of a laptopShould I read this?

This guide is for Developers.

With CoreMedia Content Cloud you do not get a program to install and run, but a workspace to develop within, to build with Maven and to deploy artifacts from.

Different deployment scenarios

By default, you have two ways to build and deploy the workspace. Both approaches base on the built of the Blueprint Workspace described below.

  • The Docker test system setup is the recommended way. It uses the Docker images to start the systems components. See Docker Compose Setup for details.

  • The Deployment Archive. It is a Zip file that contains all application artifacts required to deploy on a supported Linux system. It uses Chef to set up the CoreMedia system.

The quick start describes only one path, no options or advanced configurations are described. The "Further Reading" section of each step contains links to additional content, but you do not need to read these chapters for the purpose of the quick start.

You need Internet access and a resolvable host name to get everything up and running.

Building the Workspace

What do you get?

When you are finished with all steps, you will have built the CoreMedia Blueprint Workspace and the required Docker images for all CoreMedia applications.

Step 1: Getting a Login for CoreMedia

Goal

You have a login to the CoreMedia software download page, the contributions GitHub repository, the documentation and the CoreMedia artifact repository.

Steps

  1. Ask your project manager for your company’s account details or contact the CoreMedia support. Keep in mind, that you have to ask explicitly for the access rights to the CoreMedia GitHub contributions repository. See CoreMedia’s website for the contact information of the support at http://www.coremedia.com/support.

Check

Got to https://documentation.coremedia.com/cmcc-10 and https://github.com/coremedia-contributions/coremedia-blueprints-workspace and enter your credentials. You should be able to use the complete online documentation and see the contributions repository.

Step 2: Getting License Files for the CoreMedia System

Goal

You have licenses for the CoreMedia system.

Steps

Ask your project manager, your key account manager or your partner manager for the CoreMedia licenses.

Check

You have a Zip file that contains three zipped license files. In Docker Compose Setup you will learn where to put the license files.

Further Reading

  • See for details about the license file format.

Step 3: Checking the Hardware Requirements

Goal

You are sure, that your computer meets the hardware requirements as described in Prerequisites.

Step 4: Checking and Installing all Required Third-Party Software

Goal

All required third-party software (such as Java, Git, Maven, Sencha Cmd …​) is installed on your computer and has the right version.

Steps

  1. Open the Supported Environments document and check that you have installed the right version of Java and that you have the right OS. The JAVA_HOME variable must be set.

  2. Check that you have Maven 3.6.1 installed.

  3. Check that Sencha Cmd 7.2.0 is installed on your computer.

    Some Maven modules need more memory than Sencha Cmd provides per default. You can pass additional JVM options via the jangaroo-maven-plugin in the pom.xml of the corresponding module by using the senchaJvmArgs configuration. For the studio-base-app this value is already set to -Xms512m -Xmx2048m and can be overridden via the Maven property studio-base-app.senchaJvmArgs.

  4. Check that Docker is installed on your computer. See Docker Installation for installation instructions.

Further reading

Step 5: Cloning the Workspace

Goal

You have the Blueprint workspace on your hard disk.

Steps

  1. Make sure that you have access to the Blueprint repository. If you encounter a 404 error, then you are probably not logged in at GitHub or you do not have sufficient permissions yet.

  2. When you use a Windows system, make sure that the Git configuration parameter core.autocrlf is set to "input". Otherwise, some init files will not run properly in your test machine. Because on checkout, Git would change the line endings to Windows style.

  3. On your local machine, clone the repository into a directory blueprint using Git:

    Path length limitation in Windows

    The WORKSPACE contains long paths and deeply nested folders. If you install the WORKSPACE in a Windows environment, keep the installation path shorter than 25 characters. Otherwise, unzipping the workspace might fail or might lead to missing files due to the 260 bytes path limit of Windows.

    git clone https://github.com/coremedia-contributions/coremedia-blueprints-workspace blueprint
  4. In the cloned repository, get a list of all tags:

    git tag
  5. Create your working branch from the tag you want to use as your starting point:

    git checkout -b <yourBranchName> <tagName>

Check

The Git clone command has succeeded.

Further reading

Step 6: Getting the blob Demo Content

The textual content and the themes are already part of the workspace you have cloned before. However, to keep the workspace small, the blob content is supplied in a separate file.

Goal

The workspace contains the blob files of the CoreMedia demo content (videos, images, …​).

Steps

  1. Open the releases site and click the link to the current release.

  2. Click the "content-blobs archive" link on the site and download the file.

  3. Extract the archive into the workspace you have cloned in step 5.

Step 7: Configuring the Repository Settings and Check Maven Configuration

Goal

Your Maven settings.xml file contains the settings required to connect with the CoreMedia Nexus repository.

Steps

  1. Follow the steps described in Prerequisites.

Check

When you build the workspace, all artifacts are found.

Step 8: Building the Workspace

Goal

The workspace has been build, so that all artifacts and Docker images are built. The build takes some time. On an Intel i7 processor with 16GB RAM around 20 minutes.

Steps

In the main directory of the workspace call:

mvn clean install -DskipTests -Pwith-docker

Check

The Maven build ends with message "Build successful".

Further reading

Congratulations, you have build the Blueprint workspace and the Docker images. Continue with Docker Compose Setup in order to configure and start the Docker deployment.

Copyright © 2021 CoreMedia GmbH, CoreMedia Corporation. All Rights Reserved.