You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _articles/extended-usage/dynamsoft-service-configuration.md
+70-22Lines changed: 70 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,58 @@ description: Dynamic Web TWAIN SDK Documentation Dynamic Web TWAIN Service Page
10
10
11
11
# Configuring the Dynamic Web TWAIN Service
12
12
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.
14
14
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).
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.
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`
16
58
17
59
## IP and ports
18
60
19
61
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
+
24
65
25
66
## Access-Control-Allow-Origin
26
67
@@ -58,33 +99,40 @@ When a request comes from a different origin, a CORS error message will be displ
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
64
104
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>.
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/).
0 commit comments