Installation and Configuration
This section describes various ways of installing and configuring CrafterCMS.
First we’ll take a look at the requirements and supported platform for installing/setting up CrafterCMS.
To run CrafterCMS, the following are required:
- Java 11
- 8+ Gig of memory to JVM (additional memory may be required depending on the size and number of your web experiences)
- Git 2.20.1 and later
Please note that CrafterCMS does not require any external databases for the core system to run and deliver fully dynamic experiences. MongoDB is used by Crafter Profile and Crafter Social which are optional components that provide user management and social features.
OS (All components)
The following Operating Systems are supported (64Bit only for all OSs)
- Linux (Ubuntu, RHEL)
- macOS (10.12 and later)
- Windows via WSL
JVMs (All components)
The following JVMs are supported:
- OpenJDK 11
- Oracle JDK (HotSpot) 11
Verify Java Version
Ensure that you are running Java 11. To check, run the following command at the command prompt and make sure that the version displayed is Java 11:
The command above should output something like this:
openjdk version "11.0.11
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:
env | grep JAVA_HOME
How to set the JAVA_HOME environment variable
To set JAVA_HOME
Korn and bash shells:
export JAVA_HOME=jdk-install-dir export PATH=$JAVA_HOME/bin:$PATH
JAVA_HOME=jdk-install-dir export JAVA_HOME PATH=$JAVA_HOME/bin:$PATH export PATH
setenv JAVA_HOME jdk-install-dir export JAVA_HOME PATH=$JAVA_HOME/bin:$PATH export PATH setenv PATH $JAVA_HOME/bin:$PATH export PATH=$JAVA_HOME/bin:$PATH
OS X Prerequisite
For OS X users, the latest
openssl formula needs to be installed via homebrew:
brew install openssl
libaiois required by the Authoring install. Please note that some Linux distributions does not install the library
libaioby default and so, may need to be installed. You may get the following error when starting up Studio:
error while loading shared libraries: libaio.so.1: cannot open shared object file: No such file or directory
libaiofor Debian-based Linux distros:
sudo apt install libaio1
libaiofor RedHat-based Linux distros:
yum install libaio
For Linux users, some of the scripts uses
lsof. Please note that some Linux distributions does not come with
lsofpre-installed and so, may need to be installed.
lsoffor Debian-based Linux distros:
apt-get install lsof
lsoffor RedHat-based Linux distros:
yum install lsof
libncurses5is required for the Authoring install and the restore script. You may get the following error when running an Authoring install or the restore script without the
error while loading shared libraries: libncurses.so.5: cannot open shared object file: No such file or directory
To install the library
libncurses5, use the following commands:
On Debian-based Linux distros:
sudo apt install libncurses5
On RHEL, CentOS:
sudo yum install ncurses-compat-libs
On Fedora 22 and newer version:
sudo dnf install ncurses-compat-libs
For Windows users, WSL 2 needs to be installed. All CrafterCMS scripts/commands to be executed and items that needs to be downloaded and installed needs to be in WSL 2.
Follow the instructions here to install WSL 2.
Building with Gradle Prerequisites
For building with Gradle for installing CrafterCMS, the following must be installed in your system:
On Linux/Windows WSL 2
make and GCC
For Debian based distributions (such as Ubuntu),
GCCcan be installed through
sudo apt install build-essential
For RHEL based distributions (such as CentOS),
GCCcan be installed through “Development Tools”
yum groupinstall "Development Tools"
make and GCC, which can be installed from
XCode Command Line Tools
For macOS Catalina, a failure may occur with
node-gypwhen building like below:
[ERROR] Building: /Users/myuser/craftercms/src/studio/target/node/node /Users/myuser/craftercms/src/studio-ui/ui/scss/node_modules/node-gyp/bin/node-gyp.js rebuild --verbose --libsass_ext= --libsass_cflags= --libsass_ldflags= --libsass_library=
See https://github.com/nodejs/node-gyp/blob/master/macOS_Catalina.md for more information on resolving the issue.
CrafterCMS provides the following methods for installation depending on your environment. There are three main installation methods: - Docker - Kubernetes - AWS AMI - Binary Bundles - Build from Source
We’ll go through these one by one.
Deploy CrafterCMS in Kubernetes.
Setup CrafterCMS authoring and delivery using Crafter’s AWS AMI.
CrafterCMS provides pre-built bundles for Linux, MacOS x86 and ARM. The guide below provides instructions on how to setup a production environment.
Securing Your Install
Remember to change the default values pre-configured when installing CrafterCMS for a secure installation. See Securing Your CrafterCMS Install for more information.
Below you’ll find instructions how to enhance the delivery environment performance and how to setup various things for your delivery install