Installing and verifying prerequisites

Install Java

Download and install Java JDK 1.8 (either Oracle or OpenJDK).

Verify Java Version

Ensure that you are running Java 1.8. To check, run the following command at the command prompt and make sure that the version displayed is Java 1.8:

java -version


The command above should output something like this:

java version "1.8.0_91"

Verify JAVA_HOME environment variable is set correctly

Make sure that you have a JAVA_HOME environment variable that points to the root of the JDK install directory. To check the value set for JAVA_HOME, enter the following command at the command prompt:

For Unix/Linux Systems:

env | grep JAVA_HOME

For Windows Systems:

set JAVA_HOME

How to set the JAVA_HOME environment variable

To set JAVA_HOME on a Unix/Linux System

  • Korn and bash shells:

    export JAVA_HOME=jdk-install-dir
    export PATH=$JAVA_HOME/bin:$PATH
    
  • Bourne shell:

    JAVA_HOME=jdk-install-dir
    export JAVA_HOME
    PATH=$JAVA_HOME/bin:$PATH
    export PATH
    
  • C shell:

    setenv JAVA_HOME jdk-install-dir
    setenv PATH $JAVA_HOME/bin:$PATH
    export PATH=$JAVA_HOME/bin:$PATH
    

To set JAVA_HOME on a Windows System

  • Do one of the following:
    • Windows 7 – Right click My Computer and select Properties > Advanced
    • Windows 10 - Type advanced system settings in the search box (beside the Windows start button) and click on the match
  • Click the Environment Variables button
  • Under System Variables, click New
  • In the Variable Name field, enter: JAVA_HOME
  • In the Variable Value field, enter your JDK installation path
  • Click on OK and Apply Changes as prompted

Note

For Windows users, the path specified in your JAVA_HOME variable should not contain spaces. If the path contains spaces, use the shortened path name. For example, C:\Progra~1\Java\jdk1.8.0_91

Note

For Windows users on 64-bit systems:

  • Progra~1 = Program Files
  • Progra~2 = Program Files(x86)

OS X extra prerequisite

For OS X users, the latest openssl formula needs to be installed via homebrew:

brew install openssl

Linux prerequisite

  1. For Linux users, some of the scripts uses lsof. Please note that some Linux distributions does not come with lsof pre-installed and so, may need to be installed.

    To install lsof for Debian-based Linux distros: apt-get install lsof

    To install lsof for RedHat-based Linux distros: yum install lsof

  2. The library libncurses5 is required for running the restore script. You may get the following error when running the restore script without the libncurses5 library installed:

    error while loading shared libraries: libncurses.so.5: cannot open shared object file: No such file or directory

    To install the library libncurses5, use the following commands:

    On Debian-based Linux distros: sudo apt-get install libncurses5-dev libncursesw5-dev

    On RHEL, CentOS: sudo yum install ncurses-devel

    On Fedora 22 and newer version: sudo dnf install ncurses-devel

Windows prerequisite

Windows users using older operating systems may experience issues when Crafter CMS starts up MongoDB and see the following error:

The program can’t start because api-ms-win-crt-runtime-l1-1-0.dll is missing from your computer. Try reinstalling the program to fix this problem.

For MongoDB to startup properly, a Microsoft update may be needed for older operating systems including:

  • Windows 7
  • Windows Server 2012 R2
  • Windows Server 2012

To install the update, download the Universal C Runtime update from Microsoft ( https://support.microsoft.com/en-us/kb/2999226 ) When the update is installed, please try to start Crafter CMS again.

Another issue Windows users may experience when Crafter CMS starts up MongoDB, is the following error in the logs:

Error creating bean with name ‘crafter.profileRepository’ defined in class path resource [crafter/profile/services-context.xml]: Invocation of init method failed; nested exception is com.mongodb.MongoTimeoutException: Timed out after 30000 ms while waiting for a server that matches WritableServerSelector

Users may also see a Windows dialog with the following message:

The code execution cannot proceed because VCRUNTIME140.dll was not found. Reinstalling the program may fix this problem.

For MongoDB to startup properly, Visual Studio C++ Redistributable 2015 needs to be installed or repaired if some of the required dll is corrupted. You can download Visual Studio C++ Redistributable 2015 here: https://www.microsoft.com/en-us/download/details.aspx?id=48145. When finished installing, please restart Windows.


To Install a Production Environment

To install a production environment setup, see the section on Setting up a Crafter CMS production environment Setting up a Crafter CMS production environment

To Install a Development Environment

To install a development environment, see the section on installing Crafter CMS from the zip download or the section on installing Crafter CMS from archive built by the Gradle environment builder in the Quick Start Guide.

To learn more about the developer workflow, see Introduction to the Developer Workflow with Crafter CMS.