Shinydocs Pro Pre-Installation Checklist

The purpose of this checklist is to determine the readiness of an environment for a Shinydocs® Pro deployment. A project start may be dependent on the completion of this checklist. 

A successful implementation requires a dedicated virtual machine or bare-metal system. A single-machine configuration supports up to 40 TB of your data from various sources.

Operating System

Shinydocs Pro is designed for Microsoft Windows:

• Windows Server 2019 or newer

• Windows 11

Hardware

	Up to 40 TB
CPU Modern multi-core processor	12-16 core**
Memory (RAM)	64 GB*
Disk SSD required 10% of your expected data volume	4 TB free disk space (for 40 TB - 10% of 40 TB is 4 TB)
Network	Gigabit connection
For customers also implementing Private AI:
AI Server	(Required for Private AI integration)
CPU Modern multi-core processor	12-16 core**
Memory (RAM)	64 GB*
Disk	1 TB free disk space
Network	Gigabit connection
GPU	Nvidia based GPU with minimum 16GVRAM This is specification is for entry level performance suitable for testing. GPUs and VRAM may need to be increased based on performance.

Software 

This software will be automatically installed when you follow the Shinydocs® Pro installation: 

• Shinydocs® Search Engine 

• Shinydocs® Dashboards 

• Shinydocs® Extraction Service 

• Shinydocs® Control Center 

• Shinydocs® Search 

• Java 21 Runtime Environment 

• Microsoft® .NET Desktop runtime 8

• Microsoft® .NET ASP Core runtime 8

• Microsoft® Visual C++ Redistributable 

Access

Scanning file share content requires that the file share(s) are on the same domain as the computer running Shinydocs Pro.

Please Note: Shinydocs® Pro works best with a service account with read (for scanning) and write (for file deletion) access in your desired repository. For file share scanning, the service account will need interactive logon enabled (Group Policy dependent).

Default Ports Required By Shinydocs Pro

The following ports are required to be accessible for Shinydocs Pro though some* may not require access external to the server on a basic deployment.

The Search Engine, on a single system deployment will only require localhost (127.0.0.1) access as would the Extraction Service. If customizations or additional servers are configured for Cognitive Toolkit or scaling up is required there ports may need to be opened though restrictions are advised to limit access to those specific servers.

Endpoint and Security Software Considerations

Endpoint protection includes anti-malware, anti-virus, and other file scanning loss prevention software. For the performance and stability of Shinydocs Pro, ensure you have set up the proper exclusions with your organization’s endpoint protection solution. While these items should be scanned before they are installed, we do not recommend day-to-day operation without exclusions.

Using Sophos, SentinelOne, or CrowdStrike for AV and security? These applications, while helpful in security, heavily hinder Shinydocs Pro’s ability to process content quickly. Please exclude as much Shinydocs Pro software as possible (including JVM injected agents) for the best performance.

Endpoint protection software can be configured to accommodate the needs of Shinydocs Pro and manage exceptions. Please refer to your software’s documentation to help implement these exclusions.

Your installation locations may be different if you changed the <installation folder> during installation, the default is the C:\Program Files\Shinydocs Professional\ folder.

Path Exclusions

• <installation folder>

  • \ControlCenter
    \Dashboards
    \ExtractionService
    \Search
    \SearchEngine

• C:\ProgramData\Shinydocs

  • \ControlCenter
    \ExtractionService
    \logs
    \OpenSearchService
    \search

  • Also, if the index has been moved to it’s own location, i.e. E:\ShinyIndex\data, this should be excluded as well.

Process Exclusions

• Shinydocs.Platform.ControlCenter.Web.exe

• ShinydocsSearch.exe

• opensearch-service-x64.exe