How to Install Crafter CMS
The first thing to understand is that there are several options to install Crafter CMS. This article will focus on the most simple option, a bundle install, but for completeness, let's enumerate the various options:
- Developer Build: Crafter CMS is open source software. If you are a developer that wants to download and extend the core software or you simply want to build and run it from source you can follow these instructions here.
- Bundle Installs: Bundle installs are downloadable zip file archive-based installations you can use to easily install Crafter CMS on your local machine or servers. This article will focus on this type of install.
- Docker Images: Crafter CMS can be easily deployed into a serverless and stateless infrastructure based on Docker. Our Docker Compose files are maintained here. Our Crafter CMS Docker images are published here. And you can follow these instructions to set up and configure Crafter CMS with Docker and Kubernetes here.
- AWS Marketplace: Crafter CMS is available in the AWS marketplace as AMI(s) along with other types of images. You can find these images here along with installation instructions here.
Now that we have a bit of a better understanding of what all the options are, let's get down to business and learn how to install Crafter CMS via the bundles.
Step 1: Download Crafter CMS
Crafter CMS is a decoupled CMS and has two main components: Authoring and Delivery. By separating these components Crafter CMS accomplishes a number of important objectives including freedom of front end framework along with independent security, scale and SLA of authoring and delivery compoennts. In this tutorial you will download, install and connect both components.
Download the the authoring and delivery archives:
Tip: If you are installing the authoring and delivery components on the same machine, create top level directories for each componenent:
directory structure like this:
crafter-cms/ ├── authoring/ │ └── (extract authoring archive here) ├── delivery/ │ └── (extract delivery archive here)
Once Crafter’s files are extracted, the directory structure for each component will look like this:
[authoring|delivery]/crafter/ ├── config/ │ └── ... ├── bin/ │ └── ... ├── data/ │ └── ... ├── logs/ │ └── ... ├── temp/ │ └── ...
Step 2: Start the Authoring and Delivery Server
Start the authoring server:
Start the delivery server:
Step 3: Open Crafter Studio in a Web Browser and Log In
Open a browser and go to the following URL:
If you are installing on a local machine you can use the following URL:
Log in to the authoring component of Crafter CMS, Crafter Studio with the global admin account:
Step 4: Create a New Site
Once you have logged in to Crafter Studio, click Create Site.
This will start a wizard that will enable you to create new project in Crafter Studio. You can choose from any of the available blueprints or point to an external Git repository.
For the purpose of this tutorial you will create the a site called "myawesomewebsite" based on the Editorial blueprint.
To do this you can follow these steps here.
Once you complete the wizard, you will see your site in preview.
Step 5: Configure Delivery Server to Publish the New Site
Now that we have a website in Crafter Studio that we can modify, we want to set up the delivery server to deliver the site.
To test that our delivery server is working, but that we don't yet have it configured to deliver the published version of our site we can go to the following URL
If you are working locally you can use the following URL
At the moment this will result in an error page. We have not yet initialized the site on the delivery server. Let's do that now.
In a console, in your installation directory, execute the following command:
For our install this will look like the following
./delivery/crafter/bin/init-site.sh -b live myawesomewebsite /Users/rdanner/Desktop/craftercms/authoring/crafter/data/repos/sites/myawesomewebsite/published
Tip: It's a best practice to give the full path to the published respository for the site you are initializing as show above.
Now that we've initialized the site on the delivery system we can visit the delivery URL and see the site. Open a browser and go to your delivery URL.
Step 6: Test Publishing
Following the guide found here, make an edit to your site in the authoring tools, Crafter Studio and approve a publish. Soon after you can refresh your delivery tool and you will see the updated content.
Step 7: Build the Next Amazing Digital Experience!
Congratulations, you did it! That's really all there is to it. Now that you've got your installation up and running and you have set up publishing, your can create as many websites and digital experiences as you like. Make something amazing!
Russ Danner is VP Products at Crafter Software and is responsible for product management, product development and support, and client and partner success. Russ brings over 20 years of software architecture, design, and implementation experience. Prior to Crafter Software, Russ was Web Experience Management Practice Director at Rivet Logic and project lead for the open source Crafter CMS project.