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 Crafter CMS from the zip Download

To install Crafter CMS using the zip download:

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

    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 INSTALL_PATH/crafter directory, and execute the startup script:

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

    It takes a few seconds for Crafter CMS to startup.

    To stop Crafter CMS Server: From the command line, navigate to the INSTALL_PATH/crafter 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-authoring-cms.zip and crafter-authoring-cms.tar.gz inside the bundle folder

    ./gradlew init build deploy bundle
    
  3. Unzip the file (crafter-authoring-cms.zip or crafter-authoring-cms.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