Ensure that the Shinydocs Pro Pre-Installation Checklist has been followed and the hardware meets or exceeds the requirements before beginning the setup process.
These steps have been completed on a fresh installation of Windows Server 2022, with some basic administrative tools installed, such as Chocolatey, Notepad++, 7-Zip, and WinMerge for convenience, but these are not prerequisites.
Pre-installation Reading
-
Do you expect more than 10 TB of content for Shinydocs Pro to analyze? You should increase the JVM memory of the Search Service after installation: Increasing Search Engine Service Memory Allocation
Suggested Tools
These tools, when installed on the server, help with the success of installation and troubleshooting.
• Notepad++ (64-bit)
• 7-Zip
Prerequisites
Shinydocs Pro Pre-installation Checklist
-
The main item to note here is that we recommend using a service account with read (for scanning) and write (for file deletion) access.
-
Endpoint Protection Considerations for Shinydocs Pro
-
The Shinydocs Pro Service Account
-
A domain account, or a group managed service account (gMSA), with read rights to all files and folders of the file shares that will be targeted. To delete files with disposal, it also needs permission to delete them.
-
If Search will check file permissions, the Shinydocs Control Center service runs as this account, so it must be a local administrator on the Shinydocs Pro server.
-
The setup should be performed using this account to ensure access is established.
-
It doesn’t need interactive logon rights. See How to configure the Windows Service Account for use with Shinydocs Pro.
-
Final Checklist
Please ensure that the user account to initiate this installation, the logged-on user, is the Windows Domain Service Account created as a prerequisite.
Download and/or copy the installation file to the target server as the service account user.
Download and/or copy the provided license (.xml) file to the target server as the service account user.
Downloading the Installer and Starting Setup
-
Ensure a service account is created for use by the services, while uncommon to do so, the username cannot be the same as the server name.
-
Download the Shinydocs Pro installer and place in the Downloads folder on the new Shinydocs Pro Server. You will be provided a download URL by Shinydocs Customer Support.
-
Once completed, locate the downloaded file.
-
Right-Click on the file and open Properties…
-
Select Unblock, then OK to unblock the file. This is an important step.
-
Double-click the Shinydocs Pro installer to begin. Setup shows the install location, the components and the license agreement on one screen.
|
Important: Shinydocs Pro needs disk space for indexing and analysis. Install it on a data drive that isn’t the operating system drive, for example |
|---|
-
In Install location, keep the default,
C:\Program Files\Shinydocs Professional, or click Browse to choose a folder on your data drive.If this is an upgrade and you change the install location, you must either copy the data folder from the previous Search Engine install or update
opensearch.ymlto use the old data folder. See Relocating the Shinydocs Search Engine Data Folder.Leave Install Shinydocs Dashboards and Install Shinydocs Search Engine (required for single machine install) selected unless Shinydocs Support has told you otherwise.
-
Read the license agreement, select I agree to the license terms and conditions, then click Install.
-
Windows Server will verify elevated access
-
The install will commence…
-
You may be prompted for any prerequisites as necessary, the full installation may take up to 40 minutes, but is often less. An active endpoint protection tool, such as anti-malware or anti-virus, can slow things down though.
Please approve these manually to proceed.
-
The Shinydocs Dashboards will take a significant amount of time (~20 minutes), in the background the installer is unpacking many small files and this is time consuming.
-
Almost done…
-
The installation is complete. Click on Launch Shinydocs Pro…
-
If available, locate and load your license file, click on Choose file.
-
Click Next…
-
We recommend our customers start with a file share to become familiar with the features of Shinydocs Pro. More information is available here: Configure Content Sources
-
Shinydocs Pro is now installed.
Important
Please follow this article to ensure OpenSearch is provisioned properly for your system:
Increasing Search Engine Service Memory Allocation (Heap Size)
Further Reading: Shinydocs Pro Control Center Guide