Quick Start Guide

This section describes how to quickly install Crafter CMS and start crafting your experiences.

Here are the steps to start using Crafter CMS for development or evaluation:

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)

Note

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.

OS X extra prerequisite

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

brew install openssl

Installing Crafter CMS from the zip Download

To install Crafter CMS using the zip download:

  • Download the Crafter CMS install zip file from http://craftercms.org/downloads

    Select crafter-cms-authoring.zip or crafter-cms-authoring.tar.gz. The zip file will install a fully functional Crafter Studio instance and a Crafter Engine in Preview Mode. Out of the box, the Studio instance uses a local directory as the repository and a Derby database, which allows a quick and easy set up for local development.

  • Unzip the contents in any directory.

Starting Crafter CMS Using the Startup Script

  1. Start the Crafter CMS Server using the startup script

    To start Crafter CMS Server: From the command line, navigate to the {Crafter-CMS-unzip-directory}/crafter 3/bin/ directory, and execute the startup script:

    • Unix/Linux systems:
    startup.sh
    
    • Windows:
    startup.bat
    

    Note

    For Windows, startup.bat should be run by a user with full Administrator privileges the very first time it is run.

    Note

    It takes a few seconds for Crafter CMS to startup and takes longer to startup the very first time you startup Crafter CMS.

    To stop Crafter CMS Server: From the command line, navigate to the {Crafter-CMS-unzip-directory}/crafter 3/bin/ directory, and execute the shutdown script:

    • Unix/Linux systems:
    shutdown.sh
    
    • Windows:
    shutdown.bat
    
  2. Open Crafter Studio

    • In your browser, go to
    http://localhost:8080/studio.
    
    • Login with the following:

      • username: admin
      • password: admin

    After logging in, you should be redirected to the MySites screen, and you’re now ready to create your first website!

Installing Crafter CMS From Archive Built By the Gradle Environment Builder

To create the archives(*.zip or *.tar.gz) for installing Crafter CMS, the following must be installed in your system:

  • Java 8
  • Git 2.x+
  • Maven 3.3.x+
  1. Clone the Crafter CMS repo from github

    git clone https://github.com/craftercms/craftercms.git
    
  2. Build a deployable bundle using the Gradle Environment Builder to generate the archives crafter-cms-authoring.zip and crafter-cms-authoring.tar.gz inside the bundle folder

    ./gradlew init build deploy bundle
    
  3. Unzip the file (crafter-cms-authoring.zip or crafter-cms-authoring.tar.gz) into any directory. You may now follow the instructions listed above Start the Crafter CMS Server using the startup script to start using Crafter CMS

For more details on using the Gradle environment builder, please review: https://github.com/craftercms/craftercms/blob/master/README.md

For more details on building Crafter CMS on Windows, please review Building Crafter CMS in Windows