Skip to content

Commit e273db9

Browse files
update to internal commit a34f0f04
1 parent b0267b0 commit e273db9

File tree

200 files changed

+399
-95
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+399
-95
lines changed

_articles/extended-usage/dynamsoft-service-configuration.md

Lines changed: 70 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,58 @@ description: Dynamic Web TWAIN SDK Documentation Dynamic Web TWAIN Service Page
1010

1111
# Configuring the Dynamic Web TWAIN Service
1212

13-
> This article is meant exclusively for the Desktop Service Edition of Dynamic Web TWAIN.
13+
The Dynamic Web TWAIN Service is the core piece of Dynamic Web TWAIN. It handles the communication between hardware (scanner, webcam, etc.) and browser, manages the image buffer, and coordinates data between different modules.
1414

15-
The Dynamic Web TWAIN Service is the core piece of Dynamic Web TWAIN when running in Service mode. It handles the communication between hardware (scanner, webcam, etc.) and browser, manages the image buffer, and coordinates data between different modules.
15+
16+
## Installation of Dynamic Web TWAIN Service
17+
18+
On a desktop, when a new user accesses a web page using Dynamic Web TWAIN SDK for the first time, he will be prompted to install the Dynamic Web TWAIN Service. This is a built-in behavior of the library. The prompt will display the download link. Once the installer is downloaded, the installation process will take just a few seconds.
19+
20+
The prompt comes up when you try to [create a WebTwain instance](/_articles/extended-usage/advanced-initialization.md#instantiating-webtwain-without-onwebtwainready).
21+
22+
![Initialization](/assets/imgs/Initialization-1.png)
23+
24+
On **Windows and macOS**, double click the downloaded installer to install the service.
25+
26+
On **Linux**, instead of double clicking, the downloaded installer needs to be run using one of the following commands:
27+
28+
- Debian / Ubuntu
29+
30+
```bash
31+
sudo dpkg -i DynamicWebTWAINServiceSetup.deb
32+
```
33+
34+
- Fedora
35+
36+
```bash
37+
sudo rpm -ivh DynamicWebTWAINServiceSetup.rpm
38+
```
39+
40+
Once the installation is done, the users can click the orange sentence 'click here to verify completion' or refresh the page to start using Dynamic Web TWAIN.
41+
42+
![Initialization](/assets/imgs/Initialization-2.png)
43+
44+
## Installation Folder
45+
46+
The service is installed in the following folders on different platforms by default.
47+
48+
- Windows:
49+
- version 19.0 and later: `C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN Service {versionnumber}`
50+
- version 18.5.1 and earlier: `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}`)
51+
- macOS:
52+
- version 19.2 and later: `/Users/{username}/Applications/Dynamsoft/Dynamic Web TWAIN Service {versionnumber}`
53+
- version 19.0-19.1: `/Applications/Dynamsoft/Dynamic Web TWAIN Service {versionnumber}`
54+
- version 18.5.1 and earlier: `/Applications/Dynamsoft/DynamsoftServicex64_{versionnumber}/{installed version No.}`)
55+
- Linux:
56+
- version 19.0 and later: `/opt/dynamsoft/Dynamic Web TWAIN Service {versionnumber}`
57+
- version 18.5.1 and earlier: `/opt/dynamsoft/DynamsoftService`
1658

1759
## IP and ports
1860

1961
The Dynamic Web TWAIN Service uses `localhost` and `18622` `18625` ports for HTTP connection and `18623` `18626` ports for HTTPS connection.
20-
These ports can be configured in the `DSConfiguration.ini` file located in:
21-
- Windows: `C:\Program Files (x86)\Dynamsoft\Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_{versionnumber}`)
22-
- macOS: `Go > Applications > Dynamsoft > Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `Go > Applications > Dynamsoft > DynamsoftServicex64_{versionnumber} > {installed version No.}`)
23-
- Linux: `/opt/dynamsoft/Dynamic Web TWAIN Service {versionnumber}`(version 18.5.1 and earlier `/opt/dynamsoft/DynamsoftService`)
62+
63+
These ports can be configured in the `DSConfiguration.ini` file located in the service's installatin folder.
64+
2465

2566
## Access-Control-Allow-Origin
2667

@@ -58,33 +99,40 @@ When a request comes from a different origin, a CORS error message will be displ
5899

59100
![CORS-error-console](/assets/imgs/CORS-error-console.png)
60101

61-
## Installation of Dynamic Web TWAIN Service
62102

63-
On a desktop, when a new user accesses a web page using Dynamic Web TWAIN SDK for the first time, he will be prompted to install the Dynamic Web TWAIN Service. This is a built-in behavior of the library. The prompt will display the download link. Once the installer is downloaded, the installation process will take just a few seconds.
103+
## Web Setup
64104

65-
The prompt comes up when you try to [create a WebTwain instance](/_articles/extended-usage/advanced-initialization.md#instantiating-webtwain-without-onwebtwainready) in Service mode.
105+
The service provides a web page to know its status and make basic configurations. You can access it through <http://127.0.0.1:18625>.
66106

67-
![Initialization](/assets/imgs/Initialization-1.png)
107+
For security reasons, the web setup is disabled by default. You can add the following line to `DSConfiguration.ini` to enable it.
68108

69-
On **Windows and macOS**, double click the downloaded installer to install the service.
109+
```
110+
EnableWebSetup=TRUE
111+
```
70112

71-
On **Linux**, instead of double clicking, the downloaded installer needs to be run using one of the following commands:
113+
Screenshots:
72114

73-
- Debian / Ubuntu
115+
* Default:
74116

75-
```bash
76-
sudo dpkg -i DynamicWebTWAINServiceSetup.deb
77-
```
117+
![home](/assets/imgs/service-web-setup/home.jpg)
78118

79-
- Fedora
119+
* External Access Tab:
80120

81-
```bash
82-
sudo rpm -ivh DynamicWebTWAINServiceSetup.rpm
83-
```
121+
![external access setup](/assets/imgs/service-web-setup/external-access-setup.jpg)
84122

85-
Once the installation is done, the users can click the orange sentence 'click here to verify completion' or refresh the page to start using Dynamic Web TWAIN.
123+
On the left of the page, you can check the service's status and update the [`LogLevel`](/_articles/info/api/WebTwain_Util.md#loglevel)
124+
125+
On the right of the page, you can configure the service through the local access tab and the external access tab.
126+
127+
In the local access tab, you can update the SSL certificate for domains bound to `127.0.0.1`.
128+
129+
In the external access tab, you can update the following settings:
130+
131+
1. Host: configure an external IP so that it can be accessed by other devices.
132+
2. Firewall exception: add exception rules to the firewall to avoid the traffic being blocked by the firewall (only for Windows).
133+
3. Domain: bind a domain to the IP of your service and configure its SSL certificate.
134+
4. Bonjour service: enable Bonjour service to allow service discovery in local networks. It is needed for the [Remote Scan solution](https://www.dynamsoft.com/remote-scan/docs/introduction/).
86135

87-
![Initialization](/assets/imgs/Initialization-2.png)
88136

89137
## Msg: Dynamic Web TWAIN Service is not installed / Dynamic Web TWAIN is not installed
90138

_articles/faq/DVS-is-not-defined.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Error Troubleshooting, DVS
77
breadcrumbText: Uncaught ReferenceError - DVS is not defined
88
description: Uncaught ReferenceError - DVS is not defined
99
date: 2021-12-03 23:26:46 +0800
10+
last_modified: 2023-10-11 00:56:56 +0800
1011
---
1112

1213
# Error Troubleshooting

_articles/faq/HTTP-process-error.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Error Troubleshooting, HTTP process
77
breadcrumbText: HTTP process error
88
description: HTTP process error
99
date: 2021-12-03 23:26:46 +0800
10+
last_modified: 2025-08-14 14:09:35 +0800
1011
---
1112

1213
# Error Troubleshooting
@@ -77,8 +78,26 @@ When attempting to upload images using any of the HTTPUpload\*\*\* methods the u
7778
</configuration>
7879
```
7980

80-
If you are using `PHP` , you can change the value in the following line in the `php.ini` file:
81+
If you are using `PHP` , you can change the value in the following lines in the `php.ini` file and `web.config` file:
82+
83+
- **php.ini**
8184

8285
```shell
83-
upload_max_filesize = 2M
86+
file_uploads = On ; Enable file uploads
87+
upload_max_filesize = 50M ; Max single file size for uploads
88+
post_max_size = 60M ; Max size for POST data (includes all fields and files)
89+
max_execution_time = 300 ; Max script execution time (in seconds)
90+
```
91+
92+
- **web.config**
93+
94+
```xml
95+
<system.webServer>
96+
<security>
97+
<requestFiltering>
98+
<requestLimits maxAllowedContentLength="52428800" /><!-- 50MB -->
99+
</requestFiltering>
100+
</security>
101+
</system.webServer>
84102
```
103+

_articles/faq/HTTP-request-error.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Error Troubleshooting, HTTP request
77
breadcrumbText: HTTP request error
88
description: HTTP request error
99
date: 2021-12-03 23:26:46 +0800
10+
last_modified: 2022-06-02 15:30:49 +0800
1011
---
1112

1213
# Error Troubleshooting

_articles/faq/JPEG-compression.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Error Troubleshooting, jpeg, 24-bit, 8-bit
77
breadcrumbText: Only 24-bit true color bmp and 8-bit gray-scaled images are supported for JPEG compression
88
description: Only 24-bit true color bmp and 8-bit gray-scaled images are supported for JPEG compression
99
date: 2020-12-10 16:11:49 +0800
10+
last_modified: 2024-09-19 08:47:35 +0800
1011
---
1112

1213
# Error Troubleshooting

_articles/faq/XMLHttpRequest-cannot-load.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Error Troubleshooting, XMLHttpRequest
77
breadcrumbText: XMLHttpRequest cannot load XXX
88
description: XMLHttpRequest cannot load XXX
99
date: 2021-12-03 23:26:46 +0800
10+
last_modified: 2022-06-02 15:30:49 +0800
1011
---
1112

1213
# Error Troubleshooting

_articles/faq/acquireimage-sync-or-async.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Capture/ Image Source, acquireImage synchronous, as
77
breadcrumbText: Is the AcquireImage() method synchronous or asynchronous?
88
description: Is the AcquireImage() method synchronous or asynchronous?
99
date: 2021-12-08 03:01:32 +0800
10+
last_modified: 2022-06-10 04:40:03 +0800
1011
---
1112

1213
# Capture/Image Source

_articles/faq/activeX-in-Edge-IE-mode.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, ActiveX, Internet Explorer mode, IE mode
77
breadcrumbText: How to run Dynamic Web TWAIN ActiveX in Microsoft Edge Internet Explorer (IE) mode
88
description: How to run Dynamic Web TWAIN ActiveX in Microsoft Edge Internet Explorer (IE) mode
99
date: 2022-04-22 05:24:12 +0800
10+
last_modified: 2022-10-14 14:05:08 +0800
1011
---
1112

1213
View all FAQs about [Project Deployment and End-user Installation](

_articles/faq/add-annotation-to-image.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ breadcrumbText: Can I add annotation to an image (e.g. add watermark or text)?
88
description: Can I add annotation to an image (e.g. add watermark or text)?
99
date: 2021-12-09 09:25:33 +0800
1010
last_modified: 2025-05-20 09:25:33 +0800
11+
1112
---
1213

1314
# Image Editing

_articles/faq/additional-form-fields.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: Dynamic Web TWAIN, Document Saving, additional form fields
77
breadcrumbText: How can I send additional form fields with images to my server or database?
88
description: How can I send additional form fields with images to my server or database?
99
date: 2021-11-29 18:33:59 +0800
10+
last_modified: 2024-09-19 08:47:35 +0800
1011
---
1112

1213
# Document Saving

0 commit comments

Comments
 (0)