• Document Under Review

Reference

This section is a reference to the modules, APIs, complementary projects, and other detailed material.

Modules

CrafterCMS comprises a set of modules that work together.

The modules are

CrafterCMS Modules

Module

Description

Studio

Studio provides all the content management services to enable authoring, management, and publishing of all content.

Engine

Engine provides content delivery services to power any type of Web or mobile application.

Deployer

The content deployment system which moves content from Studio to Engine and Search.

Search

The search engine that backs content authoring and content delivery

Core

The content retrieval and in-memory database library

Commons

The shared libraries used by all CrafterCMS modules

Profile

Profile and attribute store

Social

User generated content store

APIs

Content Retrieval APIs

CrafterCMS requires you use one of the following APIs to gain access to your content:

For non-content related APIs, such as user/group management, monitoring, indexing and more, please consult the module API directly.

CrafterCMS Modules

Module

REST API

Studio

OAS Link

Engine

OAS Link

Deployer

OAS Link

Profile

OAS Link

Social

OAS Link

Java Doc

Crafter Commons

http://javadoc.craftercms.org/4.0.7/commons/index.html

Crafter Core

http://javadoc.craftercms.org/4.0.7/core/index.html

Crafter Deployer

http://javadoc.craftercms.org/4.0.7/deployer/index.html

Crafter Engine

http://javadoc.craftercms.org/4.0.7/engine/index.html

Crafter Profile

http://javadoc.craftercms.org/4.0.7/profile/index.html

Crafter Search

http://javadoc.craftercms.org/4.0.7/search/index.html

Crafter Social

http://javadoc.craftercms.org/4.0.7/social/index.html

Crafter Studio

http://javadoc.craftercms.org/4.0.7/studio/index.html

Managing Secrets

There are a number of ways to manage secrets in CrafterCMS, please review this article for more information.


Administration Scripts

Synopsis
startup.sh
Description

Starts all needed Services to have a functional
CrafterCMS Authoring/Delivery Environment
Synopsis
shutdown.sh
Description

Stops all needed Services to have a functional
CrafterCMS Authoring/Delivery Environment
Script
crafter.sh
Description



Main Script to start and stop all needed Services to have a
functional CrafterCMS Authoring/Delivery Environment
To log the output of the script to a file, set the environment
variable CRAFTER_SCRIPT_LOG to point to a log file
Synopsis
debug.sh
Description



Starts all needed Services to have a functional
CrafterCMS Authoring/Delivery Environment with the JAVA remote
debug ports open and listening port 5000/5001 for Crafter Deployer,
and 8000/9000 for Apache Tomcat
Script
deployer.sh
Description

Script located in $CRAFTER_HOME/bin/crafter-deployer which will
start,stop Crafter Deployer for the Authoring/Delivery environment
Script
crafter-setenv.sh
Description

Script located in $CRAFTER_HOME/bin/crafter-setenv.sh
Sets various environment variable to configure CrafterCMS

Let’s look at an example on how to start an authoring environment using the scripts we discussed above. To start the authoring environment, go to your CrafterCMS install folder then run the following:

cd crafter-authoring/bin
./startup.sh

What the above does is go to your authoring environment folder, then run the startup script.

To stop the authoring environment:

./shutdown.sh

Complimentary Projects

Complimentary Projects and Resources

Docker Compose

Docker Compose on GitHub

Docker Images

Docker Images on GitHub

Kubernetes

Kubernetes Deployments on GitHub

DevContentOps Toolkit (Crafter CLI)

DevContentOps Toolkit (CrafterCMS CLI)

Extensions: Plugins

CrafterCMS Sponsored Plugins on GitHub

Extensions: Blueprints

CrafterCMS Sponsored Blueprints

Marketplace

CrafterCMS Marketplace