Blueprint Developer Manual / Version 2310
Table Of ContentsWhat 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
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
Go to https://documentation.coremedia.com/cmcc-11 and https://github.com/coremedia-contributions/coremedia-blueprints-workspace and enter your credentials. You should be able to use the 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 Section 3.2.2, “Docker Compose Setup” you will learn where to put the license files.
Further Reading
See Section 4.6, “CoreMedia Licenses” in Operations Basics 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 Section 3.1, “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
Open the supported environments document at http://bit.ly/cmcc-11-supported-environments and check that you have installed the right version of Java and that you have the right OS. The
JAVA_HOMEvariable must be set.Check that a supported Maven version is installed (see http://bit.ly/cmcc-11-supported-environments).
Check that a supported Sencha Cmd version is installed on your computer (see http://bit.ly/cmcc-11-supported-environments).
Check that a supported container environment is installed on your computer (see http://bit.ly/cmcc-11-supported-environments). See Section, “Docker Installation” for installation instructions.
Further reading
Section 3.1, “Prerequisites” describes the required software in more detail.
Step 5: Cloning the Workspace
Goal
You have the CoreMedia Blueprint workspace on your hard disk.
Steps
Make sure that you have access to https://github.com/coremedia-contributions/coremedia-blueprints-workspace. If you encounter a 404 error, then you are probably not logged in at GitHub or you do not have sufficient permissions yet.
When you use a Windows system, make sure that the Git configuration parameter
core.autocrlfis 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.On your local machine, clone the repository into a directory
blueprintusing Git:
Warning
Path length limitation in Windows
The CoreMedia Blueprint workspace contains long paths and deeply nested folders. If you install the CoreMedia Blueprint 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
In the cloned repository, get a list of all tags:
git tag
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
Chapter 4, Blueprint Workspace for Developers describes the structure of the workspace, the concepts behind the workspace and how you can work with the workspace.
Section 4.2.2, “Configuring the Workspace” describes further configuration of the workspace which is required for development and deployment.
On https://releases.coremedia.com/cmcc-11 click the link to the latest download to find a description on how to download a specific release.
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
Open the releases site https://releases.coremedia.com/cmcc-11 and click the link to the current release.
Click the "content-blobs archive" link on the site and download the file.
Extract the archive into the workspace you have cloned in step 5.
Step 7: Configuring the Repository Settings and Check Maven/NPM Configuration
Goal
Your Maven settings.xml file contains the settings required to connect with
the CoreMedia Nexus repository.
The PNPM client is logged in into https://npm.coremedia.io.
Steps
Follow the steps described in Section 3.1, “Prerequisites”.
Check
When you build the workspace, all artifacts and packages are found.
Step 8: Building the Workspace with Maven
Goal
The workspace has been build, so that most of the 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 -Pdefault-image
Check
The Maven build ends with message "Build successful".
Further reading
Section 4.2.1, “Removing Optional Components” describes how you can remove parts of the workspace that you do not need.
Section 4.2.4, “In-Memory Replacement for MongoDB-Based Services” describes how you can replace MongoDB for Studio services with an in-memory solution.
Step 9: Building the Studio Client with pnpm
Goal
The Studio Client has been build, so that you can start the Docker container.
Steps
Switch into the Studio Client directory:
cd workspace/apps/studio-client
Build the Studio Client:
pnpm install pnpm -r run build pnpm -r run package
Build the Docker image:
docker buildx build . --tag coremedia/studio-client:latest
For more detailed instructions and possible build options consult apps/studio-client/README.adoc.
Step 10: Building the Frontend
Goal
The frontend has been build, so that you can use the themes and bricks.
Steps
Switch in the frontend directory with:
cd workspace/frontend
Build the frontend parts with:
pnpm install pnpm run build pnpm run build-frontend-zip
For more detailed instructions and possible build options consult frontend/README.adoc.
Now, you have build the Blueprint workspace and the Docker images. Continue with Section 3.2.2, “Docker Compose Setup” in order to configure and start the Docker deployment.
