Welcome to the dotCMS documentation site. This site contains the documentation for the latest dotCMS release.
- If you're new to dotCMS, we recommend that you review the Requirements page, install dotCMS using the Quick Start Guide, and read the Tutorial: Day One document to begin building your dotCMS site.
- To access dotCMS documentation on specific topics, please select the appropriate section on the navigation bar to the left, or select from the detailed table of contents at the bottom of this page.
- Documentation on prior release versions can be found under the Older Versions documentation section.
- To view what's new in the latest dotCMS releases, please see the What's New section, below.
- For more detailed information on changes in dotCMS 4.2.2 and previous dotCMS versions, please see the dotCMS Change Log.
- Please also browse our growing Video library for instructions and walkthroughs of many dotCMS key features.
dotCMS Versions and Changes
Each of the following sections outlines some of the major changes in the most recent dotCMS releases.
- For more information on any of these releases, please see the dotCMS Change Log.
- For documentation on any version other than the latest dotCMS release, please visit the Older Versions documentation section.
What's New in dotCMS 4.2.2
dotCMS version 4.2.2 is a maintenance release which includes several fixes for reported issues in the 4.2.0 and 4.2.1 releases.
For more information on changes in the dotCMS 4.2.2 release, please see the dotCMS Change Log.
dotCMS version 4.2.1 is a maintenance release which includes several fixes for reported issues in the 4.2.0 release.
For more information on changes in the dotCMS 4.2.1 release, please see the dotCMS Change Log.
dotCMS 4.2.0 is a significant release which includes performance improvements, several important new features and significant enhancements.
- REST APIs for Layout as a Service (LaaS):
- The Page REST API enables retrieval of all the elements of a page as either JSON or fully rendered content, easing implementation of headless CMS/CaaS, single plage applications (SPAs) and other iOT applications.
- The Content Relationships REST API simplifies pulling of related content, enabling a normal dotCMS content pull to retrieve both the matching content and all content which is related to the content pulled.
- Push Publishing and Content Editing Performance and Improvements:
- Performance of content saving and push publishing has been improved, in some cases by more than an order of magnitude.
- Vanity URLs and Language Variables are Now Content:
- Both Vanity URLs and Language Variables are now accessible as content by all existing dotCMS features and tools, including Push Publishing, importing, exporting, permissions, and REST API management.
- A new Key/Value base content type has been added, allowing you to create your own content types for associating strings and content fields with unique keys.
- A new Vanity URL base content type has been created, and you may both extend and create your own Vanity URL content types.
Only dotCMS instances that are already running dotCMS 4.X can upgrade directly to dotCMS 4.2.0. If you have not already upgrades to dotCMS 4.X, Please see the Upgrading to dotCMS 4.0 documentation for more information on new features included in the dotCMS 4.X versions, and how they may affect your installation when upgrading to dotCMS 4.X from an earlier version of dotCMS.
For more information on changes in the dotCMS 4.2.0 release, please see the dotCMS Change Log.
dotCMS version 4.1.1 is a maintenance release which includes several fixes for reported issues in the 4.1.0 release.
dotCMS 4.1.0 is a major release which includes performance improvements, several significant new features and significant enhancements.
- REST APIs to Define and Manage Content Types: Content Type management has been added to the dotCMS REST API
- New REST Endpoints for defining and managing ContentTypes, Fields and Field Variables
- New API and builders to programmatically create content types.
- UI Performance and Improvements: The backend UI performance has been improved
- Notifications cleaner and websockets can be kept alive through proxies or load balancers.
- IE 11 support
- OSGi (manageability): Felix directories can now be externalized via configurable properties
- Felix default directory and subdirectory paths can be configured/customized
- Hazelcast Caching and Network Discovery (scalability)
- Hazelcast Embedded and Client Cache Implementations
Only dotCMS instances that are already running dotCMS 4.X can upgrade directly to dotCMS 4.1.0. If you have not already upgrades to dotCMS 4.X, Please see the Upgrading to dotCMS 4.0 documentation for more information on new features included in the dotCMS 4.X versions, and how they may affect your installation when upgrading to dotCMS 4.X from an earlier version of dotCMS.
dotCMS version 4.0.1 is a maintenance release which includes a fix for a reported issue in the 4.0 release which prevented some users from being able to start dotCMS without a live Internet connection.
For more information on changes in the dotCMS 4.0.1 release, please see the dotCMS Change Log.
dotCMS 4.0.0 is a major release which includes a complete upgrade of the dotCMS back-end UI, as well as several significant new features and enhancements.
- New Back-end UI: The back-end now uses a state-of-the-art Angular 2 user interface, with major updates to:
- Look and feel.
- Navigation and organization.
- URL pathing.
- Removed Deprecated Features: A number of deprecated legacy features were completely removed.
- Additional Features and Improvements:
- JWT Authentication: Authentication on the dotCMS backend has been upgraded to use websockets.
- Preview as Mobile Devices: You may now create Device profiles which allow you to preview your site as different mobile devices.
- Dynamic Plugins (OSGI) Version Upgraded: The Apache Felix library has been upgraded to version 5.6.2 and "un-repackaged".
- If you have any plugins built for earlier versions of dotCMS, please see the Upgrading to dotCMS 4.0 documentation for details on how to make sure your plugins work with dotCMS 4.0.0.
- Elasticsearch Index Backup/Restore: dotCMS Index backup and restore has been rebuilt to use the Elasticsearch native index snapshot, replacing custom developed code used in previous dotCMS releases.
- Improved Notifications: The notification engine has been upgraded, and notifications for status of many system tasks (such as rebuilding indexes) has been added.
Please see the Upgrading to dotCMS 4.0 documentation for more information on the new features, and how they may affect your installation when upgrading to dotCMS 4.0.0 from an earlier version of dotCMS.
For more information on changes in the dotCMS 4.0.0 release, please see the dotCMS Change Log.
dotCMS version 3.7.2 is a maintenance release which includes several fixes for reported issues in the 3.7.1 release.
dotCMS version 3.7.1 is a maintenance release which includes some functionality/features improvements and fixes some reported issues in the 3.7 release.
dotCMS 3.7.0 is a major release that adds several new features and improvements, including the following:
- Static Publishing
- dotCMS 3.7.0 provides support for Push Publishing your dotCMS content to an Amazon AWS S3 server as static content, where it can be served as a static HTML site.
- For more information, please see the Static and Dynamic Publishing documentation.
- Shorty UUIds in URLs
- URLs of images can now be included as shortened ("shorty") URLs, both when referenced from within dotCMS pages and when referenced from external sources.
- For more information, please see the Displaying Content with Binary & Image Fields documentation.
- Additional Plug-ins and Extensions for Java's ImageIO
- This improvement adds dotCMS resize/thumbnail support for the following new image types:
- For more information, please see the Image Resizing and Processing documentation.
dotCMS version 3.6.2 is a maintenance release which fixes a critical security issue, improves performance, and fixes some reported issues in the 3.6.1 release.
dotCMS version 3.6.1 is a maintenance release which adds some performance improvements and fixes a number of reported issues in the 3.6.0 release.
dotCMS 3.6.0 is a major release that adds a number of new features and improvements, including the following:
- Multilingual Features
- Translation Actionlet: A new translation actionlet has been added, which allows you to create workflow actions to automatically translate content against Google's translation API.
- Multilingual Files: You can now add multiple versions of the same files in different languages.
- Finnish Translation: The dotCMS back-end has now been translated into Finnish. For more information on selecting the backend language in dotCMS, please see the Logging in to dotCMS documentation.
- Performance Features
- New H2 Cache: A new version of the H2 cache has been added with significant performance, scalability, and error handling improvements.
- Note: The original version of the H2 cache is still supported for backward compatibility.
- Improved Cache Performance: The way the default cache region is used has been changed to reduce the size of the default cache region and improve performance of cache regions which do not have their own cache chain specified.
- Additional Features and Improvements
- Elasticsearch has been upgraded to version 1.7.
- Users can now be deleted in the system.
- The default WebDAV pathing had been changed to support multilingual files and pages.
- Legacy WebDAV pathing can be restored via the
- Markdown support has been moved from a plugin into the dotCMS core via the Markdown Viewtool.
dotCMS version 3.5.1 is a maintenance release which adds some performance improvements and fixes a number of reported issues in the 3.5 release. Note that all fixes in the 3.5.1 release are already included in the dotCMS 3.6 release.
There are two major new features in dotCMS 3.5 which enable you to customize the display of your site for different users:
- The Visitors feature provides you with information about each user who visits to your site, including current information (such as user location, language and platform), and historical information (such as the tags of content the user has visited in the past).
- The Personas feature allows you to define different types of users, and then serve content to each user based on which type of user you've identified them as.
- The new pullPersonalized method automatically combines the built-in personalization features of both Visitors and Personas, enabling you to easily pull and sort personalized content for different users, displaying the content most relevant to those users at the top of the pull results.
In addition to these major new features, dotCMS 3.5 also now allows you to sort ElasticSearch queries by score, including giving different weights to different search terms, so the content most relevant to the search terms is automatically displayed at the top of the search results.
dotCMS version 3.3.2 is a maintenance release which fixes some reported security issues in the 3.3.1 release. Note that all fixes in the 3.3.2 release are already included in the dotCMS 3.5 release.
dotCMS version 3.3.1 is a maintenance release which adds some performance improvements and fixes a number of reported issues in the 3.3 release. Note that all fixes in the 3.3.1 release are already included in the dotCMS 3.5 release.
- dotCMS 3.3 includes several new cache features and improvements for Enterprise license customers:
- A new cache chain feature which enables multiple cache providers to be configured for each cache region.
- Support for Redis cache servers (including Amazon Elasticache) and a new Timed Cache provider.
- The ability to add new, custom cache providers.
- dotCMS 3.3 has been upgraded to log4j version 2.
- Many improvements have been made to Push Publishing and the Integrity Checker, including automatic detection and resolution of many complex inconsistencies without user intervention.
- Several improvements were made to the Reindexing feature, including improvements to the handling of errors and additional reindexing actions and options.
- dotCMS version 3.2 and higher run on Java 8!
- However you may still run dotCMS 3.2 on Java 7.
- Elasticsearch has been updated to support +contentType and +baseType
- New Workflow Actionlets
Pages are a new Content Type in dotCMS 3.1.
- Convert Legacy HTML Pages to Content
- Bulk Legacy HTML Page Migration Utility
- Creating a Page Content Type
- Adding a Page
- Adding a Custom Page
- Searching for a Page
- Site Browser Language Version Controls
- Content Contributor
- Building Sites
- Architecture Overview
- Tutorial: Day One
- Content Types
- Content & Widgets
- Taxonomies: Organizing Your Content
- Navigation: Menus, Crumbtrails, and Sitemap
- URL Map - SEO Friendly URLs
- Visitor Geolocation
- Server Side Compiling of Sass & Less Files
- Form Builder
- Creating a Custom Web API
- Why Velocity?
- Velocity User's Guide
- Velocity Developer's Guide
- Content Object in Velocity
- Page Content in Velocity
- Request, Response and Session
- Custom Viewtool Example
- Built-in Variables & Reserved Words
- Velocity Best Practices
- Redirects, Rewrites, and Forwards
- Tag based Caching (Block Cache)
- Integration Tools
- Useful Methods
- Push Publishing
- Dynamic and Static Publishing
- What to Know Before Push Publishing
- Push Publishing Best Practices
- Connecting Remote Servers
- Integrity Checker
- Push Publishing Content
- The Publishing Queue
- Publishing Status
- Push Publishing Dependencies
- Push Publishing Permissions
- Pushing from Content Search
- Push Publishing Workflow Actions
- Implementing Static Publishing
- Troubleshooting Push Publishing
- Push Publish Listeners Configuration
- User Management
- Site Search
- Multi-Site Management
- Multilingual Sites
- How To - Tutorials