Skip to content

Maintenance

The Maintenance page holds the two housekeeping actions that are run by hand: compacting the database and restarting the server.

Where to Find It

Open the user menu in the top-right corner, choose Admin Settings, then select Maintenance from the left-hand menu.

Running a maintenance task

Tick the tasks you want to run, then click Execute. The button stays disabled until at least one task is ticked.

Task What it does
Compact Database Removes orphaned file chunks from the files bucket, then compacts the database collections and their indexes to reclaim disk space.
Restart Server Restarts the CreativeHub server once the compaction has finished. This will not empty CreativeHub storage.

CreativeHub confirms before it starts: Are you sure you would like to compact the database? This operation can take a while and Are you sure you want to restart?. Tick both and you get a single prompt listing them instead. When the run finishes, CreativeHub reports Maintenance completed successfully and clears the tick boxes.

Warning

On a large project archive, compacting the database can take a long time. Run it when nobody is committing or publishing, and take a backup first.

Every run is recorded in the log: the request is logged as the action Maintenance: Execute, bracketed by Maintenance Started and Maintenance Finished entries under the System category.

Scheduled maintenance

Separately from this page, CreativeHub runs a scheduled maintenance task, configured in the Maintenance card of Admin Settings → Settings:

  • Maintenance - the switch in the card title. It is on by default.
  • Schedule - a Cron expression, 0 4 * * * (every day at 04:00) by default. A plain-English description of the expression is shown underneath it.
  • Jobs / Days to keep - tick Jobs to have the task delete jobs older than the number of days you set (1 to 365).

Info

The schedule uses the Cron string format. For more information: cron string

The scheduled task does two things, and both are also run once when the server starts:

  1. Finished jobs are cleared. Done, Aborted and Failed jobs more than seven days old are deleted, and, when Days to keep is set, jobs older than that period.
  2. Stuck commits are cancelled. A commit that is still pending and has not been updated for an hour is cancelled.

The switch, the schedule and Days to keep are read when the server starts. A change takes effect after the next server restart.

Note

The scheduled task does not compact the database and does not restart the server. Both are manual actions on this page.