Skip to content

server-deployment.md

Latest commit

 

History

History
82 lines (54 loc) · 4.28 KB

server-deployment.md

File metadata and controls

82 lines (54 loc) · 4.28 KB
layout default-layout
needAutoGenerateSidebar true
title Dynamic Web TWAIN SDK Deployment - Server Deployment
keywords Dynamic Web TWAIN, Documentation, Deployment, Server
breadcrumbText Server Deployment
description Dynamic Web TWAIN SDK Documentation Server Deployment Page

Deploy your application on the server

Once you have finished integrating Dynamic Web TWAIN in your application, you can deploy it on your server to test it. As far as Dynamic Web TWAIN is concerned, all related files are to be served as static files which makes the deployment very easy.

How-to

The Resources folder is typically found in the following location after the installation:

  • Windows: C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN SDK {Version Number}\
  • macOS: Applications > Dynamsoft > Dynamic Web TWAIN SDK {Version Number}

The deployment of Dynamic Web TWAIN is easy. Simply copy the Resources folder to your web server. Learn more on Set ResourcesPath

Technical details

Make sure the static files can be served correctly

Dynamic Web TWAIN comes with lots of static resources files, for the full list, check out What are the Resources files. The following table shows each file type and its MIME type which must be configured in your webserver in order for that type of file(s) to be correctly served to the client browsers.

File Type MIME Type Required by
.js application/javascript All Browsers
.css text/css All Browsers
.wasm application/wasm WASM Browsers
.msi application/octet-stream Browsers on Windows
.pkg application/pkg-mac Browsers on macOS
.deb application/x-debian-package Browsers on Linux
.rpm application/x-redhat-package-manager Browsers on Linux

Enable HTTPS

If you need to use any of the following features, you must enable HTTPS on the server.

  • Upload or Download via SSL
  • Any other features that require a secure connection

For how to enable HTTPS, please check out the manual of your webserver.

Set ResourcesPath

The global API Dynamsoft.DWT.ResourcesPath sets a relative or absolute path that tells Dynamic Web TWAIN where to look for the resources files at runtime. Its default value is Resources which means all these files are put in a directory called Resources that is in the same location as the web page on which Dynamic Web TWAIN is running. This is the simplest situation possible. However, in most cases, it's a lot more complicated and you must make sure the correct value is set.

How to know ResourcesPath is wrong

When you set ResourcesPath wrong, static files such as dynamsoft.webtwain.install.js , dynamsoft.viewer.css will fail to load and you see 404 errors in the browser console.

Change ResourcePath using an absolute path

If you wish to use an absolute path to include the library, this is supported.

<script src="https://www.dynamsoft.com/dwt/demo/Resources/dynamsoft.webtwain.initiate.js"></script>
<script src="https://www.dynamsoft.com/dwt/demo/Resources/dynamsoft.webtwain.config.js"></script>

Change ResourcePath using a relative path

If you do not wish to use an absolute path, you can change the reference path to a relative path.

Dynamsoft.DWT.ResourcesPath = "New folder/Resources";

Relocate the folder holding the client installer files

As of DWT 18.4, you can now relocate the folder that houses the Dynamic Web TWAIN Service(formerly known as Dynamsoft Service) installer files to a location outside of the Resources folder.

The below example relocates the Resources folder to a projectfiles folder in the same project, and refers externally to find the client installer files.

Dynamsoft.DWT.ResourcesPath = "../projectfiles/DWTResources";
Dynamsoft.DWT.ServiceInstallerLocation` = "https://example.com/DWTInstallers";