imDocShare On-Premises Proxy Service Install Guide

Introduction

This document outlines the steps to complete installation for the On-Premises Proxy service required to use imDocShare with an On-Premises iManage Server. This is required due to the security requirements of an on-premises server.

Our application typically uses an online app service in order to query and authenticate with the iManage API server. For on-Premises implementations, this type of server is only accessible in the same intranet network and therefore will not respond to a public app service. Our solution is to install a proxy service which re-directs to our public service without exposing the iManage server to the internet at large.

Creating an App Service

The first step is to create a basic web app service using Azure.

Once the service is live, we will provide a package to deploy our app to the service. It is important that this service is set up in the same network as your iManage 10.x Work Server as this is required to query the server. Please also ensure that your app service has a public IP so that outside services can connect to it.

Package Deployment

We will provide a package containing a .NET web app project to deploy to the service. Simply, unzip the file and use Azure’s built in KUDU advanced tool to deploy the contents to the service.

Once you have entered the debug console from the above screenshots, simply drag & drop the contents of the zip file into the root of the server directory. Once this is successful, your deployment is complete!

Once installation is complete, you will need to provide the URL property where the service can be reached. This needs to be saved in our records to process authentication and API access smoothly. This property can be found on the overview page of your service:

Testing your new Service

You can test your new service by visiting the URL above in an intranet environment. This URL should be reachable by machines in the same network. If the deployment was successful, you should see an imDocShare logo.

Installing Proxy App in IIS web server

Configure IIS features for Windows Server 2016

(It is similar for Windows Server 2019)

Follow the steps below to install Internet Information Services (IIS) on a web server computer running Windows Server 2016.

The minimum Internet Information Services (IIS) version is 10.0.

1) Click Start > Server Manager.
2) On the Server Manager > Dashboard, select  Add roles and features.

The Add Roles and Features Wizard opens.

3) Click Next on the Before you begin window.
4) On the Select installation type window, select Role-based or feature-based installation, and then click Next.

5) On the Select destination server page, select the server to configure in the Server Pool list.
6) Click Next.
7) On the Select server roles window, select the Web Server (IIS).

8) Expand Web Server(IIS), then Web Server, and then the Application Development node, and verify that ASP.NET 4.6 or later is installed.

9) Click Next.
10) Click Next on the Select features window. No additional features are needed.
11) Click Next on the Web Server Role (IIS) window after reading the information provided.
12) Click Next on the subsequent page to install the defaults.
13) On the Confirm installation selections, review the items to be installed. Click Next when you are ready to proceed with installing the IIS web server.
14) After installation has succeeded, click Close.

Install imDocShare Proxy app

After installing IIS, run IIS Manager  to make sure that the .NET Framework version 4 is assigned to the default application pool.

1) Press WINDOWS+R to open the Run dialog box.
2) Enter “inetmgr” and select OK.
3) In the Connections pane, expand the server node and select Application Pools. In the Application Pools pane if DefaultAppPool is assigned to the .NET framework version 4 as in the following illustration, skip to the next section.

4) In the Application Pools pane, select DefaultAppPool. In the Actions pane, select Basic Settings.

5) In the Edit Application Pool dialog box, check the .NET CLR version. Change to .NET CLR v4.0.30319 if it is not. Click OK.

6) In the connections panel select the Default Web Site (or the web site created for this service).
7) Double click the Configuration Editor and make sure the webserver/handlers handler is enabled.

At this point IIS should be running on port 80 by default with the firewall rule “World Wide Web Services (HTTP Traffic-In)” enabled in Windows firewall automatically. We can perform a simple test by opening a web browser and browsing to the server that we have installed IIS on. You should see the default IIS page. You can use http://localhost to connect with in server.

8) Right click Default Web Site and select Explore (This opens the default Site physical location on Windows Server C:\inetpub\wwwroot).

9) Extract the contents of imDocShare Proxy-vx.x.x.zip into the wwwroot folder.

10) Please navigate to thehttps://sync.imdocshare.com/proxysetting/index.html and fill the form. 

Note: Please make sure the iManage Host Name and Redirect URL are HTTPS URL and not HTTP.

You can get the client ID and Secret after creating an app for imDocShare in your iManage control center, to create an app please navigate to your iManage tenant using an admin account, click on the user icon on the top right, navigate to the control center and select applications, here you can

add an application by selecting the “Add Application” button on the top right of the screen.  When creating the application the redirect URL should be -  https://<your proxy domain>/api/v1.0/authorized.

Please also enable the “Allow refresh token”

11) Please open the web.config file in the root folder and input the encoded value in the “iManagesettings” field.

11) Once configured please navigate to https://localhost or https://(yourproxydomain), if successful you will see the connection established:

Install SSL certificate

SSL Certificate should be purchased from a proper Certificate provider, or your network admin can produce one for your internal network. That depends on your organization. To add an SSL certificate to IIS these steps to be followed.

Create CSR

Send CSR to certificate provider

Provider will give you options to download the Certificate file which will be .cer file.

You must download the certificate for IIS web server.
Since the certificate providers are common to all other server technologies too.

Create Certificate Signing Request Using IIS (CSR)

When you are applying or ordering an SSL certificate, you will need to create CSR (Certificate Signing Request) on your server and send it to a Certificate Authority. The CSR validates the information the CA requires to issue a certificate. After validating the CSR, the Certificate Authority will use this data to generate and issue the SSL certificate.

1) Go to Start > Administrative Tools > Internet Information Services (IIS) Manager.

2) In the left pane, click on the server’s name and double click on the Server Certificates.

3) In the right pane, click on the Create Certificate Request.

4) Provide your domain name, company name, department name, city, state, country name and click on the Next button.

5) Select the Cryptographic Service Provider, 2048 as a bit length and click on the Next button.

5) Specify the filename and the location where you want to save the CSR and click on the Finish button to create a CSR certificate.

6) After generating the CSR, you will need to give this CSR file to the Certificate Provider in order to purchase the new SSL certificate.

Install the SSL on IIS Website

Make sure that you get an SSL certificate in P7B or CER format. Once you received the SSL certificate file from the Certificate Authority save it on the server where you created the CSR. It should be IIS compactible.

1) Go to Start > Administrative Tools > Internet Information Services (IIS) Manager.

2) In the left pane, click on the server’s name and double click on the Server Certificates.

3) In the right pane, click on Complete Certificate Request.

4) Browse the certificate file (.cer), provide your domain name, select Web Hosting in the certificate store option and click on the OK button.

Assign the certificate

At this point, you have successfully installed your SSL certificate. Next, you will need to assign the certificate to your website.

1) Open the IIS Manager, expand the server’s name and click on the Default Website or the Site you created for Proxy Service, then click on the Bindings in the right pane.

2) Click on the Add button.

3) Select https, select the IP address of your website or leave it unassigned, type port 443, type your domain name, select the domain name on which you want to install SSL and click on the OK button to install the certificate.

Your SSL certificate is now installed, and the website configured to accept secure connections.

END-USER imDocShare LICENSE AGREEMENT

This is a Legally binding agreement between you (either an individual or a single entity) and KLoBot, Inc. (“KLoBot”) for the “imDocShare” Software and associated media and printed materials, and many include online or electronic documentation for imDocShare Software Product or imDocShare Software (collectively “imDocShare”). By installing, copying or otherwise using imDocShare, you are agreeing to be bound by the terms and conditions of this agreement, including imDocShare license and disclaimer of imDocShare software warranty below. Please read this document carefully before using imDocShare. If you do not agree with the terms and conditions of this agreement you should not install or use imDocShare.

1. GRANT OF LICENSE; imDocShare USE RESTRICTIONS.
In consideration for your payment of any applicable license fee for imDocShare, KLoBot hereby grants to you a personal, non-transferable (except as expressly provided in Section 4 below) and non-exclusive right to use and execute imDocShare on a single Microsoft Office 365 SharePoint Online Tenant or Microsoft SharePoint on-premises farm (collectively “tenant”), without right to sublicense imDocShare. Under no circumstance may you store, use or allow the use of imDocShare in any manner on more than one tenant at a time. You agree that you will not reverse engineer, decompile or disassemble any portion of imDocShare. If you dispose of any media or apparatus containing imDocShare, you will ensure that you have completely erased or otherwise destroyed any imDocShare contained on such media or stored in such apparatus. Except as expressly provided in Section 4 below, you may not distribute, lease, transfer for profit, loan or otherwise convey imDocShare or any portion thereof to anyone.

2. COPYING RESTRICTIONS.
In order to effect your license rights hereunder, you may install imDocShare by copying it onto the tenant for use thereon, and you may make full or partial copies of imDocShare, but only as necessary for backup or archival purposes. You agree that

(i) your use and possession of such copies shall be solely under the terms and conditions of this Agreement, and

(ii) you shall place the same proprietary and copyright notices and legends on all such copies as included by KLoBot on the authorized copy of imDocShare that you downloaded from the imDocShare web site.

3. OWNERSHIP OF imDocShare AND MEDIA.
You agree and acknowledge that KLoBot transfers no ownership interest in imDocShare, in the intellectual property in any imDocShare or in any imDocShare copy, to you under this Agreement or otherwise, and that KLoBot and its licensors reserve all rights not expressly granted to you hereunder. After you pay any applicable license fees and/or the purchase price of the applicable KLoBot, you will own the media on which imDocShare was originally provided to you hereunder and on which you subsequently copy imDocShare, but KLoBot and its licensors shall retain ownership of all imDocShare and copies of imDocShare or portions thereof embodied in or on such media.

4. TRANSFER RESTRICTIONS.
If you transfer ownership of imDocShare you may transfer imDocShare and all licenses and rights in imDocShare granted to you under this Agreement to the transferee provided that:

(i) such transferee agrees in writing to accept the terms and conditions of this Agreement, and

(ii) you also transfer all imDocShare, including all copies thereof, to such transferee. Except as provided in this Section, you may not sublicense, transfer or assign this Agreement or any of your rights or obligations under this agreement, in whole or in part.

5. U.S. GOVERNMENT USERS.
If imDocShare is acquired by or on behalf of an entity of government of the United States of America, the following provision applies: U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND. Use, duplication or disclosure of SOFTWARE by the Government is subject to restrictions as set forth in FAR 52.227.19( c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer SOFTWARE clause at DFARS 252.227.7013 and/or in similar or successor clauses in the FAR or the DOD or NASA FAR Supplement. Unpublished rights reserved under the Copyright Laws of the United States. Contractor/manufacturer is KLoBot, Inc.

6. EXPORT RESTRICTIONS.
The software is exported from the United States in accordance with the Export Administration Regulations. Diversion contrary to U.S. law is prohibited. You agree that you will not:

(i) export or re-export the software, directly or indirectly, to Iran, Syria, Sudan, Cuba or North Korea; or

(ii) release the software to a person on the denied persons list, unverified list, entity list, specially designated nationals list, debarred list or nonproliferation sanctions list (see http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm ). The foregoing obligations will apply to you unless the Office of Export Licensing of the U.S. Department of Commerce has granted authorization to you in writing for the export or re-export of the software. Your obligations under this section shall survive any termination of this Agreement.

7. ENFORCEMENT OF TERMS; TERMINATION.
If you fail to fulfill any of your material obligations under this Agreement, KLoBot and/or its licensors may pursue all available legal remedies to enforce this Agreement, and KLoBot may, at any time after your default of this Agreement, terminate this Agreement and all licenses and rights granted to you under this Agreement. You agree that KLoBot licensors referenced in imDocShare are third-party beneficiaries of this Agreement and may enforce this Agreement as it relates to their intellectual property. You further agree that, if KLoBot terminates this Agreement for your default, you will, within thirty (30) days after any such termination, deliver to KLoBot or render unusable all imDocShare originally provided to you hereunder and any copies thereof embodied in any medium.

8. DISCLAIMER OF SOFTWARE WARRANTY.
KLoBot PROVIDES imDocShare TO YOU AS IS AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY ANY KLoBot EMPLOYEE, REPRESENTATIVE OR DISTRIBUTOR WILL CREATE A WARRANTY FOR THE imDocShare, AND YOU MAY NOT RELY ON ANY SUCH INFORMATION OR ADVICE.

9. INTELLECTUAL PROPERTY RIGHTS PROTECTION.
If any third party brings a suit against you that is based on a claim that imDocShare, solely as furnished to you under this Agreement, constitutes direct infringement of any patent issued by, or copyright registered in, the United states, KLoBot shall defend such suit or proceeding and shall pay any damages and costs finally awarded therein against you with respect to such matter, provided that you promptly inform KLoBot of any such claim, furnish KLoBot with a copy of each communication, notice or other action relating to the alleged infringement and give KLoBot the authority, information and assistance necessary to settle, compromise or litigate such suit or proceeding. Following notice of a claim or a threatened or actual suit, KLoBot may, without obligation to do so, at KLoBot sole option:

(a) procure for you the right to continue to use imDocShare as furnished,

(b) replace or modify imDocShare to make it non-infringing, or

(c) discontinue your license for imDocShare and refund to you any license fee that you paid for it, less a reasonable value for use, determined by prorating such license fee on the basis of a thirty-six (36) month straight line depreciation method, applied to the period of actual use.

KLoBot shall not be obligated to defend or be liable for costs and damages if the infringement or claim thereof arises out of:

(i) use or combination of imDocShare with products or data not provided by KLoBot,

(ii) use of other than the latest unmodified release of imDocShare made available to you by KLoBot if such infringement would have been avoided by the use of such release of imDocShare,

(iii) modification of imDocShare by anyone by KLoBot,

(iv) use of imDocShare after receiving notice, or having reason to believe, that imDocShare infringes a patent or copyright of a third party, or

(v) a claim based on any portion of the Windows(r) software that may be included with imDocShare.

THE FOREGOING STATES YOUR EXCLUSIVE REMEDY AND KLoBot ENTIRE LIABILITY WITH RESPECT TO INFRINGEMENT OF ANY PATENT OR COPYRIGHT BY imDocShare, AND KLoBot SHALL HAVE NO LIABILITY WITH RESPECT TO ANY OTHER INTELLECTUAL PROPERTY RIGHT.

10. GOVERNING LAW.
This Agreement shall be governed by and interpreted in accordance with New Jersey law, excluding its choice of law rules.

11. TECHNICAL SUPPORT TERMS.

Definitions.As used herein the following capitalized terms have the meanings set forth below:

“Correction” means, without limitation, a workaround, maintenance release, patch and/or documentation change, as KLoBot deems appropriate.
“Defect” means a material failure of imDocShare to operate substantially in accordance with the applicable user guides and reference manuals.
“Update” means a maintenance or minor release of imDocShare that provides corrections or performance improvements, is designated by KLoBot as an Update and is generally made available to all KLoBot technical support customers.
“Upgrade” means a major release of imDocShare that provides new features or functional enhancement, is designated by KLoBot as an Upgrade and is generally made available to KLoBot Premium technical support customers.

Technical Support.

During any 12/24/36-month support period for which you have pre-paid the required premium support payment, KLoBot will provide you:

Notification, if you have requested to be notified, when Updates are available for downloading from imDocShare website at www.imDocShare.com ;
Notification, if you have requested to be notified, when Upgrades are available for downloading from KLoBot’ website; and
Access to My imDocShare Support Portal on KLoBot’ website through which you may:

- Download Updates when commercially available;
- Download Upgrades (Premium technical support customers only) when commercially available;
- Report Defects in imDocShare and obtain Corrections as described herein and in accordance with the types of response and timing referenced on KLoBot’ website;
- Request General advice on implementation, operation, functionality and use of imDocShare as described on KLoBot’ website;
- Participate in community forums, review KLoBot’ extensive knowledge base and obtain usage tips and other useful information regarding imDocShare, including up-to-date information on current releases, product compatibility, restrictions, enhancements, workarounds and fixes; and
- Access on-line documentation regarding imDocShare, including application notes that include installation instructions, release notes and Frequently Asked Questions (FAQs).

Defect Correction.

When you report a suspected Defect in imDocShare to KLoBot using its My imDocShare Support Portal, KLoBot will attempt, based upon information provided by you, to recreate the suspected Defect. If the Defect is confirmed, KLoBot will use commercially reasonable efforts, given the nature and scope of the Defect, to make available to you through the My imDocShare Support Portal a Correction in accordance with the guidelines set forth on KLoBot’ website. KLoBot will make available to Premium technical support customers live chat, telephone call back and live meeting support as appropriate and warranted to confirm Defects and develop Corrections.
KLoBot will not be responsible for correcting Defects in any release of imDocShare other than the most recent release of imDocShare, provided that KLoBot shall continue to support the prior release superseded by recent release for a reasonable period sufficient to allow Premium technical support customers to implement the newest release or until the end of the current non-Premium technical support period.
You agree to implement within a reasonable time all Corrections provided by KLoBot hereunder.

Limitations.

KLoBot will not be obligated to provide technical support relating to problems, errors or malfunctions caused by

malfunction of the computer system and communications network on which you have installed and are using imDocShare,
other software installed in the same SharePoint environment not licensed pursuant to this Agreement,
any use of imDocShare in disregard of any known adverse consequences, including without limitation the failure of user to make appropriate backups, warning messages, and other written instructions,
any modification to imDocShare not authorized by KLoBot,
Mainstream Support of a given SharePoint Platform has been retired by Microsoft, or
any other cause not attributable to KLoBot.

Renewal of Support.

KLoBot provides the first year of basic technical support for no additional charge. Unless renewed in accordance herewith, basic technical support will cease on the last day of the 12-month support period that commenced upon the effective date of imDocShare license.
For an additional fee, you may obtain Premium technical support. Unless renewed in accordance herewith, Premium technical support will cease on the last day of the support period for which you have paid the additional Premium technical support fee.
Support fees for additional support periods must be paid in advance on or prior to last day of the support period for which you have paid the required support fee.
Approximately forty-five (45) days prior to the termination of the then current support period, KLoBot will invoice you for renewal of technical support. The support fee due for the next support period shall be KLoBot’ then current applicable list price for renewal of technical support as of the date of invoice.
KLoBot reserves the right to withdraw technical support of imDocShare, and to alter the prices, terms and conditions for technical support in advance of any renewal of support. Any such withdrawal or alterations will become effective as of such renewal date.

Reinstatement of Support.

If you allow technical support to expire, in order to reinstate support of imDocShare, you may be required to pay to KLoBot a reinstatement support fee, the then current annual support fee, and, If you are not licensing the then current release of imDocShare, an upgrade license fee for the current release of imDocShare.
Required Identifier.

In order to access My imDocShare Support Portal you must provide the identifier issued to you when you licensed imDocShare. Upon entry of such identifier access will be granted if you have paid in full the required maintenance fee.
Termination of Technical Support.

Notwithstanding Section 4 above, resale, assignment, or transfer of the technical support provided by KLoBot is strictly prohibited and will be grounds for termination of the technical support.