Deploy LEADTOOLS Document Service on Windows Server - .NET Framework

This tutorial demonstates how to deploy the .NET Framework LEADTOOLS Document Service on a Windows Server 2019.

Overview  
Summary This tutorial covers how to host the LEADTOOLS Document Service on a Windows Service using IIS hosting.
Completion Time 30 minutes
Platform .NET Framework Application
IDE Visual Studio 2017, 2019, Visual Studio Code - Client
Development License Download LEADTOOLS

Required Knowledge

Get familiar with the basic steps of running the LEADTOOLS Document Service by reviewing the Configure and Run the Document Service - .NET Framework tutorial, before working on the Deploy LEADTOOLS Document Service on Windows Server - .NET Framework tutorial.

Note:

This tutorial covers how to deploy the LEADTOOLS Document Service to a Windows Server. However, the Document Service is an example project and not intended for a production environment.

Upload the Project

By following the steps in the Configure and Run the Document Service - .NET Framework tutorial, the Document Service project is ready to publish. Open the command line terminal, and cd into this directory: <LEADTOOLS_INSTALLDIR>\Examples\JS\Services\DocumentServicDotNet\fx.

Insert the following command into the terminal:

dotnet publish -c Release -o DocumentServiceDlls DocumentService_Nuget.sln

This command will gather the dependencies and build the project, then output all of the dll's into the <LEADTOOLS_INSTALLDIR>\Examples\JS\Services\DocumentServicDotNet\fx\DocumentServiceDlls folder. The server requires the DocumentServiceDlls folder and the LEADTOOLS License files to run the Document Service. Upload the DocumentServiceDlls folder and the LEADTOOLS License files to the server.

Setup the Server

The Windows Server has to be configure to run the service. Login to the server and open the Server Manager.

server manager application in the start menu

When the Server Manager launches, click the Add roles and features option in the main menu under Welcome to Server Manager. Click the Next button until you get to the Server Roles section. Select Web Server(IIS), then click Next to move onto Features.

Server Roles with web server IIS selected

Under the Features section, select the following:

Click Next until you get to the Confirmation page. Once on the Confirmation page, click Install to install the selected features.

Confirm installation of selected features

Install the ASP.NET Core Runtime Environment

The LEADTOOLS Document Service Fx project is a .NET Core application using .NET Framework dll's for background processes. Therefore, it requires the ASP.NET Core Runtime. Open a browser and navigate to https://dotnet.microsoft.com/download/dotnet-core/2.1. Install the Windows Hosting Bundle under the ASP.NET Core Runtime section.

ASP.NET Core 2.1 runtime install page

When the runtime environment is installed, restart the server.

Install the 2017 Visual C++ Runtime

The 2017 Visual C++ Runtime package is required to run the .NET Framework Document Service. To install the latest supported Visual C++ runtimes navigate to:

https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads

When the runtime environment is installed, restart the server.

Create a New User

Create a new user that will run the application and only have permission to access the Document Service. By restricting the user's permissions the server can be sure that only Document Service resources are accessed by the Document Service. First open the Start Menu and select Change account settings.

Start Menu change account settings

Under Other users, select Add someone else to this PC.

Click I don't have this person's sign-in information, then click Add a user without a Microsoft account. Fill out the form to create a local account. This example will use doc_service as the new user.

create a local user ccount

Click Next to crete the new user.

Create the IIS Application Pool

Open the Internet Information Services (IIS) Manager.

IIS manager search result

Right-click Application Pools and select Add Application Pool.

Add application pool menu option

Create a new application pool. This tutorial will call the new application pool DocumentServiceAppPool. For the .NET CLR version select No Managed Code, and for the Managed pipeline mode select Integrated. Click OK to create the application pool.

Add application pool settings

After the application pool has been created, open its Advanced Settings menu.

Application pool advanced setting menu option

Change the application pool's Identity to the user that was created earlier in this tutorial.

Change application pool advanced settings
Change appliction pool's identity

Click OK to apply the changes.

Create the Web Site

In the IIS Manager, right-click Sites and select Add Website.

Menu option for adding a website

Create the Document Serivce website by filling out the Add Website form. Choose a name for the application, this tutorial will call it DocumentService. Select the application pool that was created earlier in this tutorial, then select the physical path to the Document Service Dll's folder. Click OK to create the website.

Create the website

Run the Project

Open a browser on the server and navigate to http://localhost. Alternatively, you can navigate to http://<Server IP Address>:80.

Document Service running successfully

Note:

If the license file is not checked, make sure that the appsettings.json file configured correctly as seen in the Configure and Run the Document Service - .NET Framework tutorial.

Wrap-up

This tutorial showed how to deploy the LEADTOOLS .NET Framework Document Service on a Windows server.

See Also

Help Version 21.0.2021.5.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.