Merge pull request #586 from dynamsoft-docs/preview

Preview

Author: lunaaaw

faq/change-dynamsoft-service-certificate.md

@@ -22,4 +22,4 @@ To replace the default certificate, the steps are:
 - Replace the old keys in `C:\Windows\SysWOW64\Dynamsoft\DynamsoftServicex64_17\cert`
 - Restart the service
 
-NOTE: For v17.2 or higher versions, you can use the new API <a href="{{site.info}}api/Dynamsoft_WebTwainEnv.html#updatecert" target="_blank">UpdateCert</a> to automatically update the client side certificate.
+<!-- NOTE: For v17.2 or higher versions, you can use the new API <a href="{{site.info}}api/Dynamsoft_WebTwainEnv.html#updatecert" target="_blank">UpdateCert</a> to automatically update the client side certificate. -->

faq/failed-to-load-resource.md

@@ -19,36 +19,51 @@ You get an error message that says **"Failed to load resource: net::ERR_CERT_DAT
 
 ### Cause 
 
-By default, we use "127.0.0.1" for service connection. However, you may use our "local.dynamsoft.com" certificate by setting **Dynamsoft.WebTwainEnv.Host = "local.dynamsoft.com"** or **Dynamsoft.DWT.Host="local.dynamsoft.com"**. 
-
-Ref: <a href="{{site.faq}}how-come-would-you-need-local.dynamsoft.com.html" target="_blank">In which cases would I use local.dynamsoft.com instead of 127.0.0.1?</a>
-
-In this case, if you are trying to access an application that integrates a version of Dynamic Web TWAIN V15.3 ~ V17.2.5, you will get the error. Because the old "local.dynamsoft.com" certificate expired on <font color=red>January 9th, 2023</font>. 
-
-### Resolution 
-
-- For v17.1.1 or older versions, choose one of the following approaches:
-    - Method 1. Upgrade to V18.0+ which comes with a valid certificate 
-    - Method 2. If you must fix the issue on a few client machines immediately, manually update the following cert files on the client-side machine. Click <a href="https://tst.dynamsoft.com/public/download/dwt/newcert/local.dynamsoft.com/newcert.zip" target="_blank">here</a> to download the new certificate and use the new server.pem.ldsc & server_key.pem.ldsc to replace the old one under **`C:\Windows\SysWOW64\Dynamsoft\DynamsoftService(DynamsoftServicex64)\cert`**.  
-Note: the new certificate from Dynamsoft will expire on December 8th, 2023. This means you will need to update the certificate again after this certificate expires.
-     - Method 3. <a href="{{site.about}}getsupport.html" target="_blank">Contact Dynamsoft</a> for a new MSI for client-side.
-     
-- For v17.2 or higher versions, use the new API <a href="{{site.info}}api/Dynamsoft_WebTwainEnv.html#updatecert" target="_blank">UpdateCert</a> to automatically update the client side certificate before it expires. **Please go to dynamsoft.webtwain.install.js file in the Resource Folder and search the keyword "OnSSLCertInfo"**, add the following lines of code:
-    ```javascript
-    Dynamsoft.OnSSLCertInfo = function (sslExpiredDate) {
-        if ((sslExpiredDate - new Date()) / 86400000 < 15) { // Automatically updates 15 days before expiration
-            Dynamsoft.DWT.UpdateCert(
-                "https://demo.dynamsoft.com/DWT/Resources/dist/cert.zip",
-                function () {
-                    //Success callback
-                },
-                function (errorCode, errorString) {
-                console.log(errorString);
+By default, “127.0.0.1” is used for service connection. "127.0.0.1" uses a self-signed certificate because it is an internal IP address, if your environment requires high level security, self-signed certificates may not be accepted. Moreover, Android OS or Chrome OS does not accept connection between browsers and Dynamsoft Service via "127.0.0.1".
+
+
+In the case that you have used our expired certificate - local.dynamsoft.com, you will need to update to the latest VeriSign’ed certificate. The most recent expired "local.dynamsoft.com" certificate expired on <font color=red>January 9th, 2023</font> and the latest certificate will expire on <font color=red>December 8th, 2023</font>
+
+> ___Please note:___ _all official certificates issued by 3rd party come with an expiry date - generally one year. This means that each year the certificate will need to be updated if local.dynamsoft.com is used._
+
+<!-- 2. Your own domain certificate expired. -->
+
+<!-- In this case, if you are trying to access an application that integrates a version of Dynamic Web TWAIN V15.3 ~ V17.2.5, you will get the error. Because the old "local.dynamsoft.com" certificate expired on <font color=red>January 9th, 2023</font>.  -->
+
+### Resolution
+
+- **No High Level Security Requirement**:
+  Set back to self-signed certificate "127.0.0.1" by comment the line `Dynamsoft.WebTwainEnv.Host = "local.dynamsoft.com"` or `Dynamsoft.DWT.Host="local.dynamsoft.com"` out. No need to worry about the expiry date of the certificate anymore.
+
+- **High Level Security Requirement (<font color=red>Please note: you need to replace the certificate annually due to expiration</font>)**
+
+  1. (**<u>Recommended</u>**) Revert back to the self-signed certificate for "127.0.0.1". Dynamsoft understands the importance of information security and are committed to remaining one of the most security-compliant companies in the industry. Starting from April 9,2021, Dynamsoft becomes ISO 27001 certified. Although a self-sign certificate is being used all connections are limited to the device itself (127.0.0.1) which ensures security in most cases.
+
+  2. If you have to use "local.dynamsoft.com", the following methods can be taken:
+        - Method 1 (**<u>Recommended</u>**). Take advantage of the new feature -- **Remote Scan** which released in v18.0. With Remote Scan, you can limit the number of Dynamsoft Service Installations to a minimum. For more details, please refer to [What is Remote Scan](https://www.dynamsoft.com/remote-scan/docs/introduction/).
+        
+        - Method 2. If you must fix the issue on a few client machines immediately, manually update the following cert files on the client-side machine. Click <a href="https://tst.dynamsoft.com/public/download/dwt/newcert/local.dynamsoft.com/newcert.zip" target="_blank">here</a> to download the new certificate and use the new server.pem.ldsc & server_key.pem.ldsc to replace the old one under **`C:\Windows\SysWOW64\Dynamsoft\DynamsoftService(DynamsoftServicex64)\cert`**. Then restart Dynamsoft Service.
+            > Note: the new certificate from Dynamsoft will expire on <font color=red>December 8th, 2023</font>. This means you must update the certificate again after this certificate expires.
+
+        - Method 3. <a href="{{site.about}}getsupport.html" target="_blank">Contact Dynamsoft</a> for a new MSI for client-side. Please specify the exact service version build number found from the version your client currently has installed.
+
+        - Method 4 (**<u>Convenience but not recommend</u>**). For v17.2 or higher versions, you can use the new API <a href="{{site.info}}api/Dynamsoft_WebTwainEnv.html#updatecert" target="_blank">UpdateCert</a> to automatically update the client side certificate before it expires. **Please go to dynamsoft.webtwain.install.js file in the Resource Folder and search the keyword "OnSSLCertInfo"**, add the following lines of code:
+            ```javascript
+            Dynamsoft.OnSSLCertInfo = function (sslExpiredDate) {
+                if ((sslExpiredDate - new Date()) / 86400000 < 15) { // Automatically updates 15 days before expiration
+                    Dynamsoft.DWT.UpdateCert(
+                        "https://demo.dynamsoft.com/DWT/Resources/dist/cert.zip", //You may use your own URL to where the new certificate is placed.
+                        function () {
+                            //Success callback
+                        },
+                        function (errorCode, errorString) {
+                            console.log(errorString);
+                        }
+                    );
                 }
-            );
-        }
-    };
-    ```
+            };
+            ```
+            ***Please be aware that the download may not work properly in all environments due to your company's security policy.***
 
 <!--
 
@@ -62,7 +77,7 @@ Note: the new certificate from Dynamsoft will expire on December 8th, 2023. This
  then add the following code lines in DSConfiguration.ini  
 
 ```javascript
-//if you perfer to use your own valid certificate, change the local.dynamsoftwebtwain.com to your own address. As well as cert_name and key_name. 
+//if you prefer to use your own valid certificate, change the local.dynamsoftwebtwain.com to your own address. As well as cert_name and key_name. 
 [local.dynamsoftwebtwain.com]  
 cert_name=server.pem.ldsc       
 key_name=server_key.pem.ldsc  

faq/index.md

@@ -285,8 +285,7 @@ permalink: /faq/
 
 <li><a href="{{site.faq}}service-backward-compatibility.html">Can I use two different websites integrated with two different versions of Dynamic Web TWAIN on the same computer?</a></li>
 
-<li><a href="{{site.faq}}how-come-would-you-need-local.dynamsoft.com.html">In which cases would I use local.dynamsoft.com instead of 127.0.0.1?</a></li>
-
+<!-- <li><a href="{{site.faq}}how-come-would-you-need-local.dynamsoft.com.html">In which cases would I use local.dynamsoft.com instead of 127.0.0.1?</a></li> -->
 <li><a href="{{site.faq}}upgrade-to-latest-version.html">How do I upgrade my project to use the latest version of the Dynamic Web TWAIN SDK?</a></li>
 
 <li><a href="{{site.faq}}upgrade-end-user-installations.html">How do I upgrade the end-user installation for all end users once I upgrade my project?</a></li>

info/api/Addon_BarcodeReader.md

@@ -158,12 +158,12 @@ interface Result {
 
 ## getRuntimeSettings
 
-Get the current runtime settings.
+Return the current runtime settings or the settings of the specified built-in template. The template can only be "speed", "balance", or "coverage".
 
 **Syntax**
 
 ```typescript
-getRuntimeSettings(): Promise < RuntimeSettings > ;
+getRuntimeSettings(template?: string): Promise < RuntimeSettings > ;
 
 interface RuntimeSettings {
     barcodeFormatIds: number;