Coveo On-Premises Crawling Module Deployment Overview

Index Content Coveo Relevance Cloud Developer System Administrator Product Documentation
In this article

This article outlines the steps to deploy the Coveo On-Premises Crawling Module and start indexing on-premises content.

If you can open a port in your firewall to let a cloud-hosted connector access your on-premises content, you don’t need to install the Crawling Module. Instead, you can create On-Premises sources in the Coveo Administration Console. Similarly, if you want to index cloud content, you must use the dedicated source. See the connector documentation for detailed instructions.

You must install the Crawling Module on the server where the content to index is located or on a different server that has access to this content. If not all content repositories index can be accessed from a single server, you must deploy several Crawling Module instances.

  1. Ensure that the environment where you want to deploy the Crawling Module meets the requirements.

  2. Install Maestro.

  3. Check that your new Crawling Module instance appears on the Crawling Modules (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console and that its status is Up to date. See Monitor the Crawling Module for details on this page.

  4. Optionally, further configure the Crawling Module.

  5. Create a Crawling Module source.

  6. If needed, write a pre-push extension to customize the indexing process.