Skip to content

Commit 58e7f36

Browse files
a362758199a362758199
authored
Merge pull request #70 from dynamsoft-docs/2.4.11
update to 2.4.11
2 parents 6456b7b + 139645d commit 58e7f36

File tree

5 files changed

+277
-8
lines changed

5 files changed

+277
-8
lines changed

‎_data/product_version.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
version_info_list:
22
- latest version
3+
- 2.4.1
34
- 2.2.19

‎selfhosting-v2.4.1/DLSonLinux.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
layout: default-layout
3+
title: Install Dynamsoft Dynamsoft License Server on Linux
4+
keywords: Install, Dynamsoft License Server, Linux
5+
description: Steps and information about how to install Dynamsoft Dynamsoft License Server on Linux
6+
breadcrumbText: Install DLS on Linux
7+
needAutoGenerateSidebar: true
8+
---
9+
10+
# Install Dynamsoft License Server on Linux
11+
12+
## Example Environment
13+
14+
* CPU: 2 Core
15+
* Memory:2 GB
16+
* Disk Space
17+
* System: 8 GB
18+
* Data: 20 GB
19+
* OS:CentOs7.4
20+
21+
## Installation
22+
23+
The following shows all the commands and steps required to set up the Dynamsoft License Server
24+
25+
<!--### Prepare a new disk to store DLS data (optional)
26+
27+
``` shell
28+
mkdir /data
29+
# Specify a disk to mount, in our case, it is /dev/nvme1n1
30+
mkfs -t ext4 /dev/nvme1n1
31+
mount /dev/nvme1n1 /data
32+
# Configure the mounting to be automatic
33+
vim /etc/fstab
34+
# Add the following line to the fstab file
35+
/dev/nvme1n1 /data auto defaults 0 2
36+
# Re-mount
37+
mount -a
38+
```
39+
-->
40+
41+
### Download the Dynamsoft License Server v2.4.1 installer, or just copy it over to a proper location
42+
43+
``` shell
44+
cd /a-proper-location
45+
wget https://tst.dynamsoft.com/public/download/dls/2.4.1/dynamsoft_dls-linux_x64-v2.4.1.tar.gz
46+
```
47+
48+
### Unzip and start the Dynamsoft License Server
49+
50+
``` shell
51+
# Unzip the installer
52+
tar zxvf dynamsoft_dls-linux_x64-v2.4.1.tar.gz
53+
# Set permissions
54+
chmod -R 755 ./dls-linux
55+
# Start the server
56+
cd ./dls-linux
57+
./startup.sh
58+
```
59+
60+
If you use Ubuntu, to start the server, try the following instead.
61+
62+
``` shell
63+
# [optional] Install net-tools if it is not available (Ubuntu 20.04 may not come with it)
64+
sudo apt install net-tools
65+
./startup.sh
66+
```
67+
68+
### Check the status to make sure the server is up
69+
70+
``` shell
71+
ps -ef |grep dynamsoft
72+
```
73+
74+
Now, if you visit [http://127.0.0.1:48080/page/index.html#/](http://127.0.0.1:48080/page/index.html#/) in the browser, you should be able to see the management portal of the Dynamsoft License Server.
75+
76+
> You can edit startup.sh to change the listening ports.
77+
78+
Upon the first visit, you will be asked to set an admin password. A few things to note:
79+
80+
> 1. The default password is empty;
81+
> 2. The user name is admin and it can not be changed;
82+
> 3. **Currently, there isn't a way to retrieve the password should it get lost. Therefore, please keep the password secure**.
83+
84+
After that, you will land on the home page where you can find the UUID of this DLS .
85+
86+
> This UUID is require when [activating your licenses]({{site.selfhosted}}index.html#activate-the-license).
87+
88+
![DLS-HomePage-001]({{site.assets}}imgs/dls-homepage.png)
89+
90+
If you see the above page, DLS is installed correctly and is ready to process requests. In order to better integrate with your original service, and make the service more secure on the Internet, the next step is to configure the network environment - (set up a reverse proxy) - for it with the help of `nginx`. See [Configure Reverse Proxy Using Nginx]({{site.selfhosted}}configurereverseproxyusingnginx.html) on how to redirect requests for `https://www.yoursite.com/dls/*` to `https://127.0.0.1:48080/*`.
91+
92+
> NOTE
93+
>
94+
> 1. "proxy" and "https" are only required if you use one of the following products:
95+
>
96+
> * SDKs for Javascript without a local service (like Dynamsoft BarcodeReader Javascript Edition).
97+
> * SDKs for iOS (unless the user makes an exception for the application). ![dls iOS allow http]({{site.assets}}imgs/dls-iOS-allow-http.png) (Reference: https://stackoverflow.com/questions/31254725/transport-security-has-blocked-a-cleartext-http#answer-33712228)
98+
>
99+
> If "proxy" and "https" are not configured, please use `http://ip:port/` in the following steps.
100+
>
101+
> 2. For Docker Users
102+
>
103+
> DLS binds the physical information of a machine. After DLS runs for the first time, you can not change the host machine. Since it is difficult to ensure that a service is deployed on a fixed physical machine on k8s, we do not recommend deploying DLS on k8s.
104+
>
105+
> Some data in the DLS installation directory requires persistent storage. One way is to use the container like a virtual machine. If `docker stop <containerID>` was executed, use `docker restart <containerID>` to restart.
106+
> Another way is to use [volume mounts](https://docs.docker.com/get-started/05_persisting_data/) or [bind mounts](https://docs.docker.com/get-started/06_bind_mounts/).
107+
108+
## Configuration
109+
110+
With the above steps, DLS will be listening on requests sent to this URL `https://www.yoursite.com/dls/`. You can set up another DLS on another machine as the standby server just in case the main server is temporarily unavailable due to network and other reasons.
111+
112+
### Configure a Standby DLS
113+
114+
For maximum up time, a standby DLS is necessary. Assume you have installed two copies of DLS, the following are the steps to configure them
115+
116+
* Find the file `dls.json.sample` in the DLS directory, copy and rename it to `dls.json`
117+
118+
* In the configuration, there are two settings: "serverMode" and "servers". We only need to change "servers". It accepts two values, the first specifies the main DLS URL and the second, the standby URL.
119+
120+
* For the main DLS: `"servers": ["self", "https://standby.yoursite.com/dls/"]`
121+
122+
* For the standby DLS: `"servers": ["https://www.yoursite.com/dls/", "self"]`
123+
124+
> NOTE that you need to configure both the main DLS and the standby DLS separately.
125+
126+
### Configure Server URLs
127+
128+
In order for the license client to know where to find DLS, the server URLs need to be embedded in the license string.
129+
130+
By default, when you first import a license and create a project, the license string for the project will already contain a server URL which is simply the host of the website. For example, if DLS is being visited like shown in the following image, then the license string will contain server URL as `http://127.0.0.1:48080/`.
131+
132+
![dls-url-001]({{site.assets}}imgs/dls-url-config-001.png)
133+
134+
Since the client devices may visit the DLS through a proxy, the automatically detected URL can be incorrect. We can click the button "Set Server URL" and correct it:
135+
136+
![dls-url-002]({{site.assets}}imgs/dls-url-config-002.png)
137+
138+
Input the actual server URLs and save:
139+
140+
![dls-url-003]({{site.assets}}imgs/dls-url-config-003.png)
141+
142+
Once saved, all license strings will be updated to contain the server URLs.

‎selfhosting-v2.4.1/DLSonWindows.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
layout: default-layout
3+
title: Install Dynamsoft Dynamsoft License Server on Windows
4+
keywords: Install, Dynamsoft License Server, Windows
5+
description: Steps and information about how to install Dynamsoft Dynamsoft License Server on Windows
6+
breadcrumbText: Install DLS on Windows
7+
needAutoGenerateSidebar: true
8+
---
9+
10+
# Install Dynamsoft License Server on Windows Server
11+
12+
## Example Environment
13+
14+
* CPU: Intel Core 2 Duo or AMD Athlon 64 X2 5600+
15+
* Memory: 2G
16+
* OS: Windows Server 2016
17+
* Disk Space
18+
* System: 30 GB
19+
* Data: 20 GB
20+
21+
## Installation
22+
23+
### Run DLS as a service
24+
25+
* Download the installer from [Dynamsoft-Licensing-Tracking-Server v2.4.1](https://tst.dynamsoft.com/public/download/dls/2.4.1/dynamsoft_dls-win_x64-v2.4.1.zip) and unzip it to a proper location. In our case, it's unzipped to **"E:\dynamsoft_dls-win_x64-v2.4.1"**.
26+
27+
* Download [NSSM](https://nssm.cc/ci/nssm-2.24-101-g897c7ad.zip) and unzip, in our case, it's unzipped to **"E:\nssm-2.24"**.
28+
29+
* Open cmd, navigate to the directory **"E:\nssm-2.24\win64"** and run the following command
30+
31+
```cmd
32+
nssm install dynamsoft-dls
33+
```
34+
35+
* A GUI will open, fill the parameters for the application like this (change the values according to where you put the files, and change ports if ports are occupied)
36+
37+
* **Path**: `E:\dynamsoft_dls-win_x64-v2.4.1\win\bin\dynamsoftdlsx.exe`
38+
* **Startup directory**: `E:\dynamsoft_dls-win_x64-v2.4.1`
39+
* **Arguments**: `".\win\jre\bin\dynamsoftdls" -Duser.language=en -Duser.region=CA -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT --add-opens java.base/jdk.internal.loader=ALL-UNNAMED -jar ".\dls-2.4.1.jar" --server.port=48080 --data.port=30201`
40+
41+
![nssm-001]({{site.assets}}imgs/nssm-001.png)
42+
43+
* Switch to the last tab "Hooks" and choose "Application exit" as the Event and specify the parameter as
44+
45+
* **Command**: `E:\dynamsoft_dls-win_x64-v2.4.1\shutdown.bat`
46+
47+
![nssm-002]({{site.assets}}imgs/nssm-002.png)
48+
49+
* Press the button "Install Service" and you should be able to find dynamsoft-dls as one of the services in the services GUI or in **Task Manager -> Service**. If it is not started, start it.
50+
51+
> NOTE
52+
>
53+
> It usually takes a few seconds for the service to start. Sometimes it might take longer.
54+
55+
### Test the service
56+
57+
Once the server is running, you can test it via the URL [http://127.0.0.1:48080/page/index.html](http://127.0.0.1:48080/page/index.html).
58+
59+
> If you changed the port during installation, you should use that port instead.
60+
61+
Upon the first visit, you will be asked to set an admin password. A few things to note:
62+
63+
> 1. The default password is empty;
64+
> 2. The user name is admin and it can not be changed;
65+
> 3. **Currently, there isn't a way to retrieve the password should it get lost. Therefore, please keep the password secure**.
66+
67+
After that, you will land on the home page where you can find the UUID of this DLS .
68+
69+
> This UUID is required when [activating your licenses]({{site.selfhosted}}index.html#activate-the-license).
70+
71+
![DLS-HomePage-001]({{site.assets}}imgs/dls-homepage.png)
72+
73+
If the above page shows up, then the server is installed correctly and is ready to process requests. In order to better integrate with your original service, and make the service more secure on the Internet, the next step is to configure the network environment - (set up a reverse proxy) - for it with the help of `IIS` . See [Configure Reverse Proxy Using IIS]({{site.selfhosted}}configurereverseproxyusingiis.html) on how to redirect requests sent to `https://www.yoursite.com/dls/*` to `https://127.0.0.1:48080/*`.
74+
75+
> Notes
76+
>
77+
> 1. About `PsExec64.exe`
78+
>
79+
> `PsExec64.exe` is a powerful tool on windows, but it is also considered risky by antivirus software.
80+
>
81+
> Normally, DLS does not allow "start as administrator". However, in order to meet some specific needs, we allow "administrator" to create another user to start DLS, which requires the use of `PsExec64.exe`.
82+
>
83+
> When using `NSSM` as described in this article, the startup user is `Local System Account`, which means you can safely remove `win/bin/PsExec64.exe`.
84+
>
85+
> 2. "proxy" and "https" are only required if you use one of the following products:
86+
>
87+
> * SDKs for Javascript without a local service (like Dynamsoft BarcodeReader Javascript Edition).
88+
> * SDKs for iOS (unless the user makes an exception for the application). ![dls iOS allow http]({{site.assets}}imgs/dls-iOS-allow-http.png) (Reference: https://stackoverflow.com/questions/31254725/transport-security-has-blocked-a-cleartext-http#answer-33712228)
89+
>
90+
> If "proxy" and "https" are not configured, please use `http://ip:port/` in the following steps.
91+
92+
## Configuration
93+
94+
With the above steps, DLS will be listening on requests sent to this URL "https://www.yoursite.com/dls/". You can set up another DLS on another machine as the standby server just in case the main server is temporarily unavailable due to network and other reasons.
95+
96+
### Configure a Standby DLS
97+
98+
For maximum up time, a standby DLS is necessary. Assume you have installed two copies of DLS, the following are the steps to configure them
99+
100+
* Find the file `dls.json.sample` in the DLS directory, copy and rename it to `dls.json`
101+
102+
* In the configuration, there are two settings: "serverMode" and "servers". We only need to change "servers". It accepts two values, the first specifies the main DLS URL and the second, the standby URL.
103+
104+
* For the main DLS: `"servers": ["self", "https://standby.yoursite.com/dls/"]`
105+
106+
* For the standby DLS: `"servers": ["https://www.yoursite.com/dls/", "self"]`
107+
108+
> NOTE that you need to configure both the main DLS and the standby DLS separately.
109+
110+
### Configure Server URLs
111+
112+
In order for the license client to know where to find DLS, the server URLs need to be embedded in the license string.
113+
114+
By default, when you first import a license and create a project, the license string for the project will already contain a server URL which is simply the host of the website. For example, if DLS is being visited like shown in the following image, then the license string will contain server URL as `http://127.0.0.1:48080/`.
115+
116+
![dls-url-001]({{site.assets}}imgs/dls-url-config-001.png)
117+
118+
Since the client devices may visit the DLS through a proxy, the automatically detected URL can be incorrect. We can click the button "Set Server URL" and correct it:
119+
120+
![dls-url-002]({{site.assets}}imgs/dls-url-config-002.png)
121+
122+
Input the actual server URLs and save:
123+
124+
![dls-url-003]({{site.assets}}imgs/dls-url-config-003.png)
125+
126+
Once saved, all license strings will be updated to contain the server URLs.

‎selfhosting/DLSonLinux.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ mount -a
3838
```
3939
-->
4040

41-
### Download the Dynamsoft License Server v2.4.1 installer, or just copy it over to a proper location
41+
### Download the Dynamsoft License Server v2.4.11 installer, or just copy it over to a proper location
4242

4343
``` shell
4444
cd /a-proper-location
45-
wget https://tst.dynamsoft.com/public/download/dls/2.4.1/dynamsoft_dls-linux_x64-v2.4.1.tar.gz
45+
wget https://tst.dynamsoft.com/public/download/dls/2.4.11/dynamsoft_dls-linux_x64-v2.4.11.tar.gz
4646
```
4747

4848
### Unzip and start the Dynamsoft License Server
4949

5050
``` shell
5151
# Unzip the installer
52-
tar zxvf dynamsoft_dls-linux_x64-v2.4.1.tar.gz
52+
tar zxvf dynamsoft_dls-linux_x64-v2.4.11.tar.gz
5353
# Set permissions
5454
chmod -R 755 ./dls-linux
5555
# Start the server

‎selfhosting/DLSonWindows.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ needAutoGenerateSidebar: true
2222

2323
### Run DLS as a service
2424

25-
* Download the installer from [Dynamsoft-Licensing-Tracking-Server v2.4.1](https://tst.dynamsoft.com/public/download/dls/2.4.1/dynamsoft_dls-win_x64-v2.4.1.zip) and unzip it to a proper location. In our case, it's unzipped to **"E:\dynamsoft_dls-win_x64-v2.4.1"**.
25+
* Download the installer from [Dynamsoft-Licensing-Tracking-Server v2.4.11](https://tst.dynamsoft.com/public/download/dls/2.4.11/dynamsoft_dls-win_x64-v2.4.11.zip) and unzip it to a proper location. In our case, it's unzipped to **"E:\dynamsoft_dls-win_x64-v2.4.11"**.
2626

2727
* Download [NSSM](https://nssm.cc/ci/nssm-2.24-101-g897c7ad.zip) and unzip, in our case, it's unzipped to **"E:\nssm-2.24"**.
2828

@@ -34,15 +34,15 @@ nssm install dynamsoft-dls
3434

3535
* A GUI will open, fill the parameters for the application like this (change the values according to where you put the files, and change ports if ports are occupied)
3636

37-
* **Path**: `E:\dynamsoft_dls-win_x64-v2.4.1\win\bin\dynamsoftdlsx.exe`
38-
* **Startup directory**: `E:\dynamsoft_dls-win_x64-v2.4.1`
39-
* **Arguments**: `".\win\jre\bin\dynamsoftdls" -Duser.language=en -Duser.region=CA -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT --add-opens java.base/jdk.internal.loader=ALL-UNNAMED -jar ".\dls-2.4.1.jar" --server.port=48080 --data.port=30201`
37+
* **Path**: `E:\dynamsoft_dls-win_x64-v2.4.11\win\bin\dynamsoftdlsx.exe`
38+
* **Startup directory**: `E:\dynamsoft_dls-win_x64-v2.4.11`
39+
* **Arguments**: `".\win\jre\bin\dynamsoftdls" -Duser.language=en -Duser.region=CA -Djavax.net.ssl.trustStoreType=WINDOWS-ROOT --add-opens java.base/jdk.internal.loader=ALL-UNNAMED -jar ".\dls-2.4.11.jar" --server.port=48080 --data.port=30201`
4040

4141
![nssm-001]({{site.assets}}imgs/nssm-001.png)
4242

4343
* Switch to the last tab "Hooks" and choose "Application exit" as the Event and specify the parameter as
4444

45-
* **Command**: `E:\dynamsoft_dls-win_x64-v2.4.1\shutdown.bat`
45+
* **Command**: `E:\dynamsoft_dls-win_x64-v2.4.11\shutdown.bat`
4646

4747
![nssm-002]({{site.assets}}imgs/nssm-002.png)
4848

0 commit comments

Comments
 (0)