CrafterCMS 4.0 Documentation (beta)
This documentation introduces key concepts in CrafterCMS 4.0, presents the authoring and development environment, and provides operational and administrative considerations and procedures as well as a comprehensive reference section.
What is CrafterCMS
CrafterCMS is a modern content management platform for building digital experience applications including:
- Single Page Applications (SPAs) using frameworks like React, Vue, and Angular
- Native mobile apps and headless applications (IOT, digital signage, wearables, etc.)
- HTML5 websites using Bootstrap or other HTML frameworks
- e-commerce front-ends
- OTT video experiences on AWS Elemental Media Services
- AR/VR applications using A-Frame
Crafter is a dynamic CMS based on Git and supports DevContentOps processes for code and content. It is also a hybrid-headless, API-first (GraphQL, REST, in-process) CMS, and that allows developers to use their favorite UI frameworks and tools.
CrafterCMS differentiates itself from existing CMSs with its architecture: microservices-based, serverless, elastic and planet-wide scalability. To learn more, see the General Architecture.
When/where to use CrafterCMS
Who uses CrafterCMS
What do I need to run CrafterCMS
Follow these instructions to run CrafterCMS and to download and install Crafter on your machine or server: Quick Start Guide
Does CrafterCMS require Git? My company uses XYZ source code control system…
No. CrafterCMS does not require your development team to use Git. CrafterCMS employs a Git-based repository and publishing system, which comes embedded in every CrafterCMS. Using Crafter’s Git-based repository for your content application’s source code is optional. You may continue to use the Source Code Management System of your choice for development.
Do I need to run MongoDB in order to run CrafterCMS?
No. MongoDB is not mandatory for CrafterCMS to operate. MongoDB backs optional functionality in the platform.
CrafterCMS is composed of independent services that you can activate/de-activate as needed. Two CrafterCMS services rely on MongoDB:
Crafter Profile which provides identity management, a distributed user attribute store and advanced targeting capabilities. Crafter Social which provides support for User Generated Content (UGC). These components add powerful capabilities to support your digital experiences but are not mandatory for CrafterCMS to deliver dynamic/personalized digital experiences.
Do I need to connect CrafterCMS to a database?
No. It is not mandatory for CrafterCMS to connect to any external databases. Crafter Studio embeds and manages its own database. Crafter Social and Crafter Profile leverage MongoDB. These are optional components.
Can CrafterCMS be used as a portal?
Yes. CrafterCMS is running portals for some of the most well known companies in the world. Use cases include intranets, global extranets, B2B portals, B2E portals and B2C portals in hospitality, finance, logistics, education and telecom and many others.
Many people hear the word portal and immediately search for a “portal” technology that meets the JSR-268 standard. CrafterCMS does not support JSR-268 natively. We do integrate with Liferay Portal and have been deployed in cases where stronger WCM capabilities were required than what Liferay provides out of the box.
You only need JSR-268 if you want to build and deploy your application as “portlets.” Doing so certainly has some advantages like the ability to leverage different application stacks for different applications in the portal. However, from an IT management perspective, unless there is good justification for different technology, doing so creates issues with technology management and total cost of ownership.
Can CrafterCMS be used for E-Commerce?
Yes. CrafterCMS helps build great e-commerce sites which gives marketing total control of the user experience while integrating with the back-end e-commerce functionality of your choosing.
Can CrafterCMS be used to build a marketing site?
Yes. Marketing sites are one of the top use cases for CrafterCMS. CrafterCMS gives marketers powerful tools to create and deploy dynamic, personalized experiences for users. Crafter also integrates with sales and marketing tools such as Salesforce, Marketo, Hubspot, Omniture, Google Analytics, iContact and many others.
How long does it take to build a CrafterCMS website?
Project duration depends on complexity of the website or other digital experience you are building. A project might be as short as a day or it could take 9 months to complete. Typical real-world sites with a sophisticated design, personalization and back end integration will take between 3 and 6 months to complete.
Crafter’s tools enable an agile development methodology. Many organizations create and deploy a phase one project quickly and then leveraging Crafter’s capabilities quickly iterate to deliver continuous value in the form of new features to the site on a regular cadence.
How do I contribute to CrafterCMS?
You can find out more about contributing bug reports, code, documentations and tests here: Contribute
What’s CrafterCMS’s licensing terms?
- CrafterCMS, the open source project is licensed under the GPLv3 Open Source license.
- Customers who purchase CrafterCMS’s support subscription receive a commercial license that alleviates them from the terms of the open source license.
- Getting Started
- Installing CrafterCMS on Linux
- Installing CrafterCMS on MacOS
- Installing CrafterCMS on Windows
- Your First Project (headless)
- Your First Project (templated)
- General Architecture
- Deployment Architecture
- API Reference
- Working with Crafter Studio’s APIs
- Working With URL Interceptor/Servlet Filters in CrafterCMS
- Working with Dates and Time Zones in Groovy
- Working with REST Services
- Working with Sass in CrafterCMS
- Content Inheritance
- Content Search
- Content Targeting
- Overriding Logging Levels
- Changing the Data and Logs Folder Location
- Developer Workflow (DevContentOps)
- Introduction to the Developer Workflow with CrafterCMS
- Code Repository & DevContentOps Workflow
- Connecting the Production CMS to the Development Workflow
- Configuration and Implementation: Production Content Repository <–> Code Repository Sync and Code Release Publishing
- Implementation of the DevContentOps Workflow
- Site Administrator
- System Administrator
- Deployment Architecture
- Installation and Upgrading
- Studio’s Core Configuration
- Changing the Session Timeout
- Publishing Blacklist
- Configure Multi-Tenancy in Engine
- Configure Single-Tenancy in Engine
- Engine’s Configuration Overrides
- Turn Off Show Error
- Deployer System Administration Guide
- Deployer Processors Guide
- Target Templates Guide
- Elasticsearch Configuration Guide
- Crafter Profile System Administration
- Crafter Profile Admin Console UI
- Crafter Social System Administration
- Crafter Social Admin Console UI
- Reverse Proxy Configuration
- Performance and Scaling
- Backup and Recovery
- Disaster Recovery
- Troubleshooting CrafterCMS
- Security Advisories
- Security Policies
- Security Processes
- Release Notes
- API Reference
- DevContentOps Toolkit