Quick Start Guide

This section describes how to quickly install Crafter CMS and start crafting your experiences. The steps listed below is intended to help the user start using Crafter CMS for development or evaluation only.

There are a couple of ways to setup Crafter CMS:

  • Install from the archive download

  • Install from archive built by the Gradle environment builder

    Note

    For Windows Users
    Windows users needs to enable Windows Subsystem for Linux (WSL) and install a Linux distribution .
    All commands executed on the command line below needs to be executed in a terminal running on the WSL distro you installed. Also, all items that needs to be downloaded and installed needs to be in WSL.
    See here for more information on WSL.

    Crafter CMS may also be run via Docker. Note that the preferred method of installing and running Crafter CMS is via the archive through WSL as described here.

Installing Crafter CMS from the Archive Download

Here are the steps to start using Crafter CMS for development or evaluation by installing Crafter CMS from the archive download:

  1. Download and install Java 11

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

    Make sure that you have a JAVA_HOME environment variable that points to the root of the JDK install directory. See here for more information on the JAVA_HOME environment variable

  2. Download Crafter CMS archive

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

    Select crafter-cms-authoring-3.1.X.tar.gz. The .tar.gz 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 an embedded database, which allows a quick and easy set up for local development.

  3. Extract the Crafter CMS archive

    Extract the contents in any directory.

    tar -zxvf crafter-cms-authoring-3.1.X.tar.gz -C /tmp/extract_to_some_directory/
    

    The extracted files should look like this:

    {Crafter-CMS-unzip-directory}
    |--crafter/
       |--LICENSE
       |--README.txt
       |--bin/
    

  4. Start Crafter CMS

    To start Crafter CMS:

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

    ./startup.sh
    

    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:

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

    ./shutdown.sh
    

  5. Access 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 Sites screen, and you’re now ready to create your first experience!

Installing Crafter CMS From Archive Built By the Gradle Environment Builder

  1. Download and install required items for creating archives

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

    • Java 11

    • Git 2.x+

    • Maven 3.3.x+

    • make and GCC

    For more information on installing the required items and other prerequisites, see Installing and verifying prerequisites

  2. Clone the Crafter CMS repo from GitHub

    git clone https://github.com/craftercms/craftercms.git
    

  3. Build a deployable bundle

    Build a deployable bundle using the Gradle Environment Builder to generate the archives crafter-cms-authoring-3.1.X.tar.gz inside the bundle folder

    ./gradlew clone build deploy bundle
    

  4. Unpack the file (crafter-cms-authoring-3.1.X.tar.gz) into any directory. You may now follow the instructions listed above starting from the step to Extract the Crafter CMS archive 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