Skip to main content
Skip table of contents

Increasing Search Engine Service Memory Allocation (Heap Size)

REMEMBER TO ALWAYS

  • Set the minimum and maximum to the same value

  • Only ever set the memory pool values to a maximum of half of the available system memory, up to a maximum of 31 GB

  • If you have a cluster of Search Engine nodes, this must be applied on each node.

Before you start

Before increasing the heap size of Shinydocs Search Engine, the service must be restarted for the changes to take effect.

  1. Stop Shinydocs Control Center service to halt any active analysis

  2. Stop Shinydocs Search Engine service

Steps

  1. Open an administrative command prompt

    1. Right-click Command Prompt and select "Run as administrator"

  2. Navigate to the Shinydocs Search Engine bin directory to launch the Service Manager

    1. If using a custom installation, go to your Search Engine bin folder

    2. For default installations:
      Run the following in the console window, which will automatically open the Service Manager:
      "C:\Program Files\Shinydocs Professional\SearchEngine\bin\opensearch-service-mgr.exe" //ES//shinydocs-search-engine

    3. Custom install location:

      • Use cd in the console window to change the directory the console is in
        e.g. cd "C:\Program Files\Shinydocs Professional\SearchEngine\bin"

        • If Shinydocs Professional is installed on another drive, you must tell the console window to change to that drive first
          e.g. D:

      • Launch the service manager Run the following command:
        opensearch-service-mgr.exe //ES//shinydocs-search-engine

  3. In the Java tab, increase the Initial memory pool and Maximum memory pool to the same value in MB. Here are the recommended values based on your systems memory.
    (Total RAM / 2) - 1 GB

System RAM

Initial/Maximum memory pool value (MB)

16 GB

7168

32 GB

15360

64 GB

31744

  1. Click OK to apply the changes

  2. Start:

    1. Shinydocs Search Engine service

    2. Shinydocs Control Center service

image-20240410-152425.png

Memory set to 4 GB (4096 MB)

image-20260127-131734.png

Memory set to 31 GB (31744 MB)

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.