Maintenance

Last Updated: May 26, 2022
documentation for the dotCMS Content Management System

A variety of maintenance tasks can be executed from the back end. To access these tasks, click on System → Maintenance in the admin panel.

Maintenance portlet.

A Word of Caution ⚠️

The back-end maintenance tasks listed in this section can have adverse site-wide repercussions if not executed properly. Only trained dotCMS content architects, system administrators, or developers should attempt these maintenance tasks. It is recommended that a dotCMS backup be conducted before executing certain high-risk maintenance tasks.

System Maintenance Tabs

The child pages of the Maintenance portlet's documentation are organized by task, while below is a summary of the section's tab divisions.

Cache

Manage and view statistics on site caches from this tab. For more information, see:

Picture of the Cache tab.

Index

This tab provides an interface for site indexes. For more information, see:

Picture of the Index tab.

During the process of reindexing, you can view a real-time display of the progress.

The Index tab displaying a reindex.

Tools

The most varied of the sections, Tools offers methods for performing a number of operations. These include:

Picture of the tools tab.

Log Files

From this tab, you can view or manage your log files, utilizing dotCMS's flexible, extensible framework. For a detailed look at this feature, see Log File Viewing.

You can even use logs to debug your use of the Velocity Template Language.

Log Files tab in System Maintenance.

System Info

From the System Info tab, you can reference system and host properties, information about the dotCMS build, environment variables, and more.

System Info tab.

Threads

From Threads, you can view current and peak thread counts, perform stack traces on individual threads, or generate thread dumps.

Threads tab.

Logged Users

Logged Users displays basic information about users currently logged in and permits the invalidation of active sessions.

Logged Users tab.

System Jobs

System jobs gives a readout on recurring jobs and services in operation, including some basic properties, scheduling, and behavior on error.

System Jobs tab.

On this page