• Document Under Review

Installing CrafterCMS on MacOS

This section describes in detail how to install/setup CrafterCMS on MacOS.

Prerequisites

  1. Download and install Java 11

    Download and install Java JDK 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 and install Git 2.20.1 or later+

    Git 2.20.1 or later is required by CrafterCMS and may need to be installed if not already installed in the server.

Installing CrafterCMS from Prebuilt Binaries

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

  1. Download CrafterCMS binary

    Download the CrafterCMS install binary file from https://craftercms.org/downloads

    Select crafter-cms-authoring-VERSION.tar.gz. The .tar.gz file will install a fully functional authoring instance. Out of the box, the authoring instance uses a local directory as the repository and an embedded database, which allows a quick and easy set up for local development.

  2. Extract the CrafterCMS binaries

    Extract the contents in any directory.

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

    The extracted files should look like this:

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

  3. Start CrafterCMS

    To start CrafterCMS:

    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 CrafterCMS to startup and takes longer to startup the very first time you startup CrafterCMS.

    To stop CrafterCMS:

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

    ./shutdown.sh
    

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