Reindexing a workspace

Reindexing a workspace in Magnolia CMS rebuilds the search index to ensure content is searchable, typically after configuration changes or repository issues. Follow these steps to reindex a workspace.

This page describes the manual way of reindexing on a self-hosted instance. In DX Cloud, it can be done with the Delete indexes action in the Cockpit. For more information, see Delete indexes and workloads after restore.

Procedure

  1. Locate the workspace directory

    Navigate to the workspace folder at /<CATALINA_HOME>/webapps/<contextPath>/repositories/magnolia/workspaces/<workspace_name>, where <workspace_name> is the specific workspace (website, contacts, and so on). Each workspace contains a workspace.xml file that configures indexing settings.

  2. Create a full backup of the instance

    Before reindexing, create a full backup of the instance. For more information about this, see Backing up and restoring instances.

  3. Shut down the Magnolia instance

  4. Delete the index subfolder

    • Delete the index subfolder in the specific workspace directory (/<CATALINA_HOME>/webapps/<contextPath>/repositories/magnolia/workspaces/<workspace_name>/index).

  5. Optional: Update indexing configuration

  6. Restart Magnolia

    Start the Magnolia instance. The system automatically rebuilds the index for the workspace upon startup. Reindexing time depends on the amount of data in the workspace.

  7. Check for errors

    Monitor the startup process for errors. If the repository is corrupted, reindexing may fail, and you may need to address the underlying issues.

Additional notes

  • The onWorkspaceInconsistency parameter

    If a workspace performs a re-indexing on startup and finds an inconsistency, the re-indexing process will fail.

    Add the OnWorkspaceInconsistency parameter in the workspace.xml file to prevent the failure. The process will just log the inconsistency.

    <param name="onWorkspaceInconsistency" value="log"/>

  • Ensure the Magnolia instance has sufficient resources, as reindexing large datasets can be resource-intensive.

  • For complex setups, contact and consult our Support.

Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules