Navigating faster using Full-Text Search feature

Introduction

The Full-Text Search feature provided by the Control Panel allows you to search for the necessary string not only among the names of documents, emails, etc. but also within their content.

ONLYOFFICE uses Elasticsearch, an open-source, broadly-distributable, and ready-scalable search engine. Elsaticsearch is built on top of Lucene, a free and open-source search engine software library, and, therefore, it is excellent for fast full-text search. The documents stored in Elasticsearch are distributed across different containers known as shards, which are duplicated to provide redundant copies of the data in case of hardware failure.

Using Elasticsearch not only significantly reduces the time spent searching for a particular file or a text line but also enhances the search precision.

Enabling the Full-Text Search feature

To turn on full-text search within document contents,

1. Sign in to your portal and click the Control Panel icon on the Start Page. Alternatively, you can go to the portal Settings and select the Control Panel link on the left-side panel.
2. Switch to the Full-Text Search section.
3. Check the Search in documents content checkbox and/or Search in mail messages content to enable the full-text search in the Document module or in the Mail module, respectively, and click Save. The stored files will be indexed in the corresponding modules.

Reindex Full-Text Search

If the file you are looking for is not among the search results (e.g., in the Documents module), and you are sure that it exists, an indexing error might have occurred.

To rebuild indexes in a separately selected portal module,

1. Switch to the Full-Text Search section in the Control Panel.
2. Click the Reindex button on the right of the necessary module section.

To rebuild all indexes,

1. Switch to the Full-Text Search section in the Control Panel.
2. Click the Reindex all button.

Changing Elasticsearch consumed memory

In some cases, you might need to change the amount of Elasticsearch consumed memory.

To change the consumed memory,

1. Open the configuration file:
   • For Windows systems - C:\ProgramData\Elastic\Elasticsearch\config\jvm.options
   • For Linux systems - /etc/elasticsearch/jvm.options
2. Change the following parameters:
   1. -Xms1g
   2. -Xmx1g

   The number indicates the amount of used RAM in GB.

3. After changing the configuration file, restart the elasticsearch service.