Skip to main content
Skip table of contents

Installing Enterprise Search for Shinydocs Pro

Shinydocs Pro versions 3.0.1 and earlier do not automatically install Enterprise Search. This document describes the steps necessary to install Enterprise Search manually based on the software downloads you would have received from Shinydocs.

The steps described in this document are not required if you are installing Shinydocs Pro 3.1 or above.

Introduction

Enterprise Search uses Microsoft® Internet Information Services (IIS) for Windows Server and Windows Authentication with Kerberos to authenticate a user from an internet browser. This guide outlines the Shinydocs™ Enterprise Search prerequisites and the steps to installing Enterprise Search, covering:

  • Setting up the site

  • Setting up Secure Socket Layer (SSL)

  • Configuring Kerberos pass-through

Software

Enterprise Search is an application that runs on Microsoft Internet Information Services (IIS).

Component

Version

Internet Information Services (IIS)

Windows Server 2019: IIS Version 10.0 or above

Windows Server 2022: IIS Version 10.0 or above

Microsoft .NET Framework 

4.7.2 or higher

Shinydocs Enterprise Server

Installation files

Internet Information Services (IIS) Features 

Before installing Enterprise Search, please enable and install the following Windows Roles and Features. These can be enabled in Windows Server Manager > Add Roles and Features Wizard.

Role

Location

http://ASP.NET

Web Server (IIS) > Web Server > Application Development Features

.NET Extensibility 4.x

Web Server (IIS) > Web Server > Application Development Features

Windows Authentication

Web Server (IIS) > Web Server > Security

Installing Enterprise Search

  1. Extract shinydocs-search-<version>.zip to the directory where you want the application to reside

  2. Ensure permissions are set properly for the extracted folder

    1. Right-click on the extracted folder and go to Properties > Security 

    2. Add IIS_IUSRS to the permissions of the folder and give Read access

    3. Ensure IIS_IUSRS or the Application Pool user has Write access to the Web.config file

  3. Create the Enterprise Search site

    1. Start Internet Information Services (IIS) Manager

    2. In the Connections panel on the left side, expand the tree

    3. Right-click on Sites and select Add Website

    4. In the Add Website window, enter a Site name (for example, Enterprise Search)

    5. Enter the Physical path to the extracted folder from Step 1 (for example, C:\Shinydocs\ Search\shinydocs-server-1.11.1.0-68)

    6. Set the port you wish to use (44300 is recommended if configuring SSL)

  4. Configure the Enterprise Search site authentication in IIS

    1. Select the Enterprise Search site you created in the previous steps

    2. In the middle panel, under the IIS section, double-click Authentication 

    3. Enable Anonymous, Windows Authentication and ASP.NET Impersonation

    4. Disable Basic Authentication, and Forms Authentication

  5. Using IIS Manager Restart the Application

Setting Up Secure Sockets Layer (SSL) on the Enterprise Search Site

  1. Start Internet Information Services (IIS) Manager

  2. Add HTTPS binding to the site

    1. With your site selected in the Connections panel, select Bindings in the Actions panel

    2. In the Site Bindings window, click Add

    3. Select “https” from the Type dropdown

    4. Ensure IP address is “All Unassigned” (for typical deployment)

    5. If your organization has multiple websites running on a single IP address, update the Host name field with the domain or subdomain value

    6. Specify the Port (typically port 44300 for SSL)

    7. Select the ShinydocsPlatformSelfSigned SSL certificate dropdown if you have already used the Platform installer.

    8. Click OK

 

Setting Up Enterprise Search on an Alternate Server

  1. Open the Shinydocs Pro Control Center installation folder

  2. Open the “Properties” folder

  3. Edit the following section in config.yaml to match your configuration

CODE
search:
  scheme: https
  host: localhost
  port: 44300
  1. After a crawl has completed the updates will automatically be applied.

    1. If you do not wish to wait for an auto-update open the web.config in your enterprise search installation folder

    2. Modify the “PlatformUrl" key by entering the correct value that represents the Control Center URL

JavaScript errors detected

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

If this problem persists, please contact our support.