loading table of contents...

3.2. Prerequisites

In order to work with the Blueprint workspace you need to meet some requirements.

[Warning]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.

Account

In order to get access to the download page, to the CoreMedia contributions repository and to CoreMedia's Maven repository (https://repository.coremedia.com), you need to have a CoreMedia account. You can obtain an account from CoreMedia Support.

Getting the CoreMedia Workspace

You can use Git to clone the CoreMedia DXP 8 workspace via:

Or you can download a Zip file of a specific tag:

Find the current online documentation at:

You will also find the download links at the CoreMedia release page at http://releases.coremedia.com/dxp8.

Hardware

  • At least a dual-core CPU with 2GHz, a quad-core CPU is recommended, because CoreMedia CMS code makes heavy use of multithreading.

  • The minimum RAM you need is 8GB which is enough if your locally tested components are connected to remote test environments. If the system is started by vagrant locally you will need at least 12GB of RAM. In both scenarios 16 GB are recommended.

  • The operating system must provide adequate resources to the components. At least 5000 processes and 25000 file handles should be available initially. You should then monitor the system to tune these settings, because the number and the types of deployed components vary greatly. In Unix environments the ulimit command can be used to configure resource limits for individual users.

Development Scenario

Minimum

Recommended

Using Remote System

 8GB 16GB

Using CMS Components started in Vagrant

 12GB 16GB

Table 3.1. Overview of minimum/recommended RAM


Required Software

  • A supported Java SDK (see Supported Environments). The variable JAVA_HOME must be set.

  • A supported browser (see Supported Environments)

  • Maven 3.3.3

  • An IDE. CoreMedia suggests IntelliJ Idea because it has the best support for CoreMedia Studio development.

  • If you want to build the workspace with tests, you need a PhantomJS 2.1.1 installation on your computer that is added to your path.

  • CoreMedia license files for starting the various Content Servers. If you do not already have the files, request your licenses from the CoreMedia support.

[Warning]Warning

Security-Enhanced Linux (SELinux)

By default, the preconfigured CoreMedia test system deployment does not support SELinux. If you want to use SELinux, you have to adapt the setup on your own as part of further hardening efforts for your production environment.

Developer Setup

In the developer setup, all components are running in VirtualBox, including the required databases, but not the WCS.

[Warning]Warning

CentOS / Redhat Enterprise Linux 6 only

The original vagrant based setup deployment approach is supported on CentOS / Redhat Enterprise Linux 6.7 only. Thus all related configuration files in the Blueprint workspace are suitable for Apache 2.2 and SysV init by default.

Please refer to deployment/chef/README.md for more information regarding the new flexible deployment approach supporting CentOS / Redhat Enterprise Linux 7.2 as well (including Apache 2.4 and systemd init).

See also https://atlas.hashicorp.com/coremedia.

  • VirtualBox 5.0.16

  • Vagrant 1.8.1

  • Chef Development Kit 0.12.0

    The ChefDK is the easiest way to get started with Chef. It defines a common workflow for cookbook development, including dedicated tooling like Kitchen and Berkshelf. 

    $ chef -v
Chef Development Kit Version: 0.12.0
chef-client version: 12.8.1
berks version: 4.3.0
kitchen version: 1.6.0

    Please note that the preconfigured Chef Client in our Vagrant test setup is 12.8.1.

    A dedicated Chef Server 12.6.0 is recommended for production deployments. Especially to handle sensitive secrets like database passwords, SSL certificates or API tokens. Please refer to, for example, chef-vault as a solid option beyond Encrypted Data Bags via a shared secret.

    A dedicated private Chef Supermarket server 2.5.2 or higher is recommended to improve your Chef Cookbook release process (optional).

Further installation and configuration requirements for Vagrant and VirtualBox can be found in Section 3.3.4, “Configuring Vagrant Based Setup”.

Non-Virtualized Setup

In the non-virtualized setup, you have to install the required databases locally and also start all CoreMedia components on your computer.

Additional Software for e-Commerce Blueprint only
  • [Note]

    An IBM WebSphere Commerce 7.0 Feature Pack 7 / Fix Pack 9 system with installed Interim Fixes (IFixes) for the following Authorized Program Analysis Reports (APAR)

    • JR55049.fp ("Cumulative Interim Fix for WebSphere Commerce Version 7 Fix Pack 9")

    • JR52306.fep (Mandatory cumulative interim fix for WebSphere Commerce Version 7 Feature Pack 7")

  • [Note]

    An IBM WebSphere Commerce 7.0 Feature Pack 8 / Fix Pack 9 system with installed Interim Fixes (IFixes) for the following Authorized Program Analysis Reports (APAR)

    • JR56287.fp and JR56287.fep ("Cumulative Interim Fix for WebSphere Commerce Version 7")

    • JR56662 ("JR56217 regression issue")

    • JR57043 ("BCS error due to token created for Store 0")

Additional Software

  • A repository manager such as Nexus or JFrog Artifactory. For evaluation purposes you can build the Blueprint workspace against the original repositories, but if you start your real project with multiple developers you will need a repository manager.

For an overview of exact versions of the supported software environments please refer to the Supported Environments document at CoreMedia Online Documentation.

Internet access

CoreMedia provides the CoreMedia Digital Experience Platform 8 components as Maven artifacts. These components in turn depend on many third-party components. If your operator has not yet set up and populated a local repository manager, you need Internet access so that Maven can download the artifacts.

[Note]Note

Maven and Internet access

The CoreMedia Blueprint workspace relies heavily on Maven as a build tool. That is, Maven will download CoreMedia artifacts, third-party components and Maven plugins from the private CoreMedia repository and other, public repositories. This might interfere with your company's internet policy. Moreover, if a big project accesses public repositories too frequently, the repository operator might block your domain in order to prevent overload. The best way to circumvent both problems is to use a repository manager like Sonatype Nexus, that decouples the development computers from direct Internet access.

Prev Up Next
 Home