Tag: Web Service

Categories
Knowledge Support Support Categories exacqVision Webservice Products

How to use the Surf web-browser on M-Series recorders

The M-Series recorders from exacqVision come with a web browser called Surf. Surf is a very basic web browser that is well suited to the capabilities of the M-Series recorder. Surf doesn’t have any window controls (address bar, back-button, etc.), so common browser tasks are accomplished with shortcut keys.
Surf can be launched using the Terminal with the following command:

For example:

Refer to the following table for Surf usage details.

Ctrl-h

Walks back the history


Ctrl-l

Walks forward the history


Ctrl-k

Scrolls page upwards


Ctrl-j

Scrolls page downwards.


Ctrl-b

Scroll up one whole page view


Ctrl-Space

Scroll down one whole page view


Ctrl-i

Scroll horizontally to the right


Ctrl-u

Scroll horizontally to the left


Ctrl-Shift-k

Zooms page in


Ctrl-Shift-j

Zooms page out


Ctrl-Shift-q

Resets Zoom


Ctrl-p

Loads URI from primary selection


Ctrl-r

Reloads the website


F11

Toggle fullscreen mode

<br>

How-to-use-the-Surf-web-browser-on-M-Series-recorders.pdf
Categories
Knowledge Support Support Categories exacqVision Webservice Products

Configuring HTTPS for ExacqVision Web Service

Version 8.4 and Higher


Using the provided Web Service configuration UI you are able to configure HTTPS support.

  1. Login to the configuration Interface here: http://127.0.0.1/service.web
  2. Click on the ‘Configuration’ link in the left hand navigation bar. This will expand with more options.
  3. Click on the ‘HTTPS’ link.
  4. Click on the ‘Configure’ button.
    If you already have an SSL certificate and private key (e.g. purchased from DigiCert, Thawte, GoDaddy, etc) choose External.
    Select “Let’s Encrypt / ACME” to provision a certificate and private key automatically. NOTE: There are prerequisites that have to be met to use this option.
  5. Follow the instructions for the chosen configuration below

<br>

Configuring HTTPS using an External Certificate

IMPORTANT: Wildcard certificates cannot be uploaded through the exacqVision Web Service administration interface. However, they may be used when manually configured. See Manually Configuring HTTPS for Web Service Certificate and Key Path for details.


NOTE: Both the certificate and private key must be PEM encoded. The private key should be in RSA format.

  1. Click on the File button next to the Certificate input and select the certificate to upload.
  2. Click on the File button next to the Private Key and select the corresponding private key to upload.
  3. (Optional) If you were given a certificate chain from your certificate provider click the File button next to the Certificate Chain input and select the chain certificate to upload.
  4. Click Apply to upload the files.
  5. Follow the prompts to restart the Web Service for the changes to take effect.
  6. (Optional) Modify the External URL of your Web Service to use HTTPS.
    • This option is found under Configuration | Basic

      NOTE: If you do not see any File buttons then you are using an older browser. Instead paste the contents of each file into the large text boxes provided.

<br>

Configuring HTTPS using Let’s Encrypt / ACME Server

Please check that the following prerequisites are met before proceeding.

A. Your Web Service is configured and running on the standard port (80)
B. Your Web Service is accessible over the internet at the domain name(s) you wish to provision a certificate for.

  1. In the input under Domain Name enter the domain name you wish to provision a certificate for.
  2. (Optional) If you have any Subject Alternative Names to add to the certificate enter them into the input under Subject Alternative Name(s)
  3. Click Apply
  4. A dialog should popup with the status of your request. Provisioning a certificate may take a few minutes, please be patient.
  5. If a certificate was issued successfully follow the prompts to restart the Web Service for the changes to take effect.
    • If an error is encountered attempt to solve the underlying issue before retrying. The production Let’s Encrypt service will rate limit you if you attempt too many times in a row. See https://letsencrypt.org/docs/rate-limits/ for more information.
  6. (Optional) Modify the ExternalURL of your Web Service to use HTTPS.
    • This option is found under Configuration | Basic

<br>

Version 8.2 and Lower

Follow the instructions to manually configure HTTPS support in the Web Service.

Windows: See Article 995
Linux: See Article 946

<br>

Categories
Knowledge Support Support exacqVision Webservice Categories Products

Using exacqVision Web Service with Edge Cameras

Edge cameras cannot run the exacqVision Web Service. If you want to connect to an Edge camera using the Web Client or the Exacq Mobile 3 app you will need to install the exacqVision Web Service on another machine.

The web service can be run on other machines but you will need to enter the Web Service Configuration to change the default server address from the loop back of 127.0.0.1 to the address of your Edge device(s).

Unlike an NVR installation of the exacqVision Server, the Edge Server application does not permit changing the default listening port for incoming client connections. Therefore, if you need to use the web service with Edge cameras you will need to configure the proper port forwarding for these connections. The addresses and port forwarding used depend on where you are placing the web service, and whether you are using multiple Edge devices behind the same router.

<br>

Web Service Inside LAN

If the web service is inside the same Local Area Network as the Edge cameras, you may use the Server Connections page in the Web Service Configuration to connect the web service to each Edge camera. This requires minimal port forwarding in the router.

<br>

Web Service Across WAN

If the web service is placed outside of the Local Area Network the Edge cameras are on, you will need to configure port forwarding as well as port translation. Port translation is used because the listening port of the Edge servers cannot be changed from their default port numbers. 

NOTE: Some home or small business routers may not be capable of port translation.

<br>

Categories
Knowledge Support Support Categories exacqVision Webservice Products

Setting up a secure ESM instance to see video with a configured web service

Product

  • exacqVision Enterprise System Manager 2.0.4 to 5.10

Note: As of version 5.12, ESM no longer utilizes a Web Service to directly stream live video.  The instructions below only apply to version 5.10 and lower.

Description

Setting up a secure ESM to see video with a configured exacqVision Web Service.

<br>

How to set up a certificate for Web Service

If your ESM is using https, the web service must also be using HTTPS to stream video to the ESM UI. See links to KB’s below to configure your exacqVision Web Service for SSL.

Note: For your web browser to securely reach your exacqVision Web Service located internally on your network, you must port forward your secure web service port (default 443) to the internal IP of your exacqVision Web Service.

<br>

Categories
Knowledge Support Support Categories exacqVision Webservice Products

Disable or Uninstall exacqVision Web Service

Description

If you are not using the exacqVision Web Service and for cybersecurity reasons want to disable, you can either uninstall it or disable it from starting.

<br>

How to Disable the Web Service

Windows

Start -> Programs -> exacqVision Web Service -> Set exacqVision Web Service to start manually.

Or

Open Windows Services by going to Start -> Type “services” or “services.msc” in the Start Menu search -> Choose Services

Once Services is open, Find “exacqVision Web Service” -> Double-Click exacqVision Web Service -> change Startup Type: to Manual or Disable -> apply -> OK

<br>

Linux

Open a terminal window Applications -> Accessories -> Terminal and type sudo /usr/local/exacq/webservice/service.sh manual

<br>

How to Uninstall the Web Service

Windows

Start -> Programs -> exacqVision Web Service -> Uninstall

or

Go to Control Panel -> Programs and Features -> Locate and highlight “exacqVision Web Service” -> Choose Uninstall

<br>

Linux

Open a terminal window Applications -> Accessories -> Terminal and type Sudo dpkg –remove webservice

<br>

Disable-or-Uninstall-exacqVision-Web-Service.pdf
Categories
Knowledge Support Support Categories Products exacqVision Integrations

Kantech Web Service Port Conflict Resolution

The Problem

When Kantech EntrapassWeb is installed alongside exacqVision Webservice software running on 3rd party (COTS – Commercial Off-the-Shelf) hardware, there will be a conflict on port 80. Port 80 is the port responsible for receiving and responding to http web requests. Both exacqVision Webservice and EntrapassWeb have are configured to use this port as default.

  • EntrapassWeb uses Microsofts IIS web server configured for port 80
  • ExacqVision Webservice uses Apache web server configured for port 80

<br>

Who is affected

Anyone running Kantech EntrapassWeb and exacqVision Webservice on COTS hardware will be affected by this. Note that exacq-built machines that come with Kantech onboard have already been configured to eliminate this conflict. The IIS web service on an exacq-built machine is configured for port 81.

<br>

The Solution

The solution is to change the port value for Microsoft’s IIS web server to port 81. To do this follow these steps.

  1. Click Start (not shown)
  2. Type iis
  3. Click on Internet Information Services Manager

4.Navigate down to Default Web Site

5. Click Bindings

6. Select the http entry

7. Click Edit

8. Change Port value to 81

9. Click OK

10. Start or Restart the IIS Web Site

11. Then close the IIS Manager

Now EntrapassWeb will respond to port 81.

From a web browser on the local machine, enter 

From a web browser on a remote machine enter 

  • (where <IPaddress> is the IP address of the exacqVision server)

To get the exacqVision Webservice:

  1. From a web browser on the local machine enter 
  2. From a web browser on a remote machine enter 
    (where <IPaddress> is the IP address of the exacqVision server)

<br>

Kantech-Web-Service-Port-Conflict-Resolution.pdf
Categories
Knowledge Support Categories exacqVision Webservice

Dewarping of Axis hemispheric cameras does not work through web service

Affected platforms

exacqVision web service 7.4

<br>

Symptom

The Axis dewarping library uses OpenGL and therefor will not work when launched as a Windows service or without access to X Windows in Linux.

<br>

Workaround

Run the webservice as an application rather than a service.

In Windows:
1. Start => Run cmd enter
2. Run the command “c:\Program Files (x86)\exacqVision\WebService\bin\evws-frontend.exe” debug
NOTE: The quotes are required

In Linux:
1. Open the terminal
2. Run command /usr/local/exacq/webservice/webservice

<br>

Resolution

Any fix is dependent on Axis modifying how their dewarping libraries work.

<br>

Dewarping-of-Axis-hemispheric-cameras-does-not-work-through-web-service.pdf
Categories
Knowledge Support Support exacqVision Webservice Categories Products

How to disable all logging in the web service

Description

Note: This KB contains the information found in KB 24844, as well as additional information.

Based on a customer request ,the following steps document how to disable all logging in Apache:

  1. Use a text editor to open the Apache configuration file.
    – Windows: C:\Program Files (x86)\exacqVision\WebService?\Apache\conf\httpd.conf.
    – Linux: /etc/evapache/httpd.conf
  2. Find the following line in the Access log
    – CustomLog “logs/access.log” common
  3. Add a hashtag/pound sign at the start:
    – #CustomLog “logs/access.log” common
  4. Find this line in the Error log
    – ErrorLog “logs/error.log”
  5. Add a hashtag/pound sign at the start:
    – #ErrorLog “logs/error.log”
  6. Save the file and restart the exacqVision Web Service.

    Note: Depending on the user’s SSL configuration, the above steps may need repeated in the httpd-ssl.conf file.
How-to-disable-all-logging-in-the-web-service.pdf
Categories
Knowledge Support Support Categories exacqVision Webservice Products

Using the ExacqVision Web Service to Connect to a Server on a Non-default Port

  1. Open a web browser on the server and type http://127.0.0.1 as the URL to access the Web Service. Click on the Web Service Configuration link in the bottom-right corner.
    <br><br>
  2. Enter the Web Service administrator username and password to log in.<br><br>
  3. Edit the port number to match the custom port number configured for your server.
    • For Web Service version 7.8 and above: Open the Server Connections page, click Add Server to add a new server, or highlight an existing entry and click Edit.
      <br><br>
    • For Web Service version 7.6 and earlier: Open the Servers page and type the new port over the existing port. Click on Update Configuration and then confirm to restart the Web Service.

<br>

Categories
Knowledge Support Highlighted Support Categories exacqVision Webservice Products

Using SSL with exacqVision Web Service (Linux)

Version 8.4 and Higher

Follow the instructions in Article 1002 to configure HTTPS support in the Web Service.

<br>

Version 8.2 and Lower

SSL, a security system combining authentication and encryption, is used to protect communication between a web server and client. Enabling SSL on a web server allow all clients connecting to that server two key protections:

  1. The client is able to identify the server. There is no way for a fake server to misrepresent itself to a client.
  2. The communication between the client and server is encrypted, preventing a third-party from seeing what data is sent. This ensures the safety of private communication such as usernames and passwords, video data, and more.

NOTES:

  1. This article assumes that exacqVision Web Service version 3.10 or later has been installed with default settings. If you are running version 3.0 to 3.8, see the attached legacy PDF.
  2. A self-signed certificate allows you to use a web browser, but it does not work with mobile devices. Only trusted third-party certificates work with mobile devices.

To use SSL with exacqVision Web Server in Linux, complete the following steps:

  1. Stop exacqVision Web Server by typing sudo /usr/local/exacq/webservice/service.sh stop in a Terminal window.
  2. Open the Web Server Apache Configuration file by typing sudo gedit /etc/evapache/httpd.conf in a Terminal window.
    Find the following lines:

    #Include /etc/evapache/extra/httpd-ssl.conf
    #LoadModule socache_shmcb_module modules/mod_socache_shmcb.so
    #LoadModule ssl_module modules/mod_ssl.so
  3. Delete the pound signs (#) at the beginning of each line.
  4. Save and close the file.
  5. It is recommended, but not required, that you disable the access log for SSL, as this file can grow very large. To do this, open the Apache SSL Configuration file by typing sudo gedit /etc/evapache/extra/httpd-ssl.conf in a Terminal window.
    Find the line with the following text:

    TransferLog “${SRVROOT}/logs/access.log”
    Change it to:#TransferLog “${SRVROOT}/logs/access.log”When finished, save and close the file.
  6. Open the Web Service configuration file by typing sudo gedit /etc/webservice.conf
    Add the following lines to the end of the document:

    [Broker]
    ssl_private_key = /etc/evapache/server.key
    ssl_certificate = /etc/evapache/server.crt

    When finished, save and close the file.
  7. If you were issued certificates, rename them to server.crt and server.key and save them to the /etc/evapache directory and then skip to Step 10. Otherwise, continue with the following steps.
  8. Run cd /etc/evapache in a Terminal window.
  9. To create a self-signed certificate, type sudo openssl req -new -x509 -sha256 -days 365 -nodes -out /etc/evapache/server.crt -keyout /etc/evapache/server.key and answer the questions.

    NOTE:     COMMON NAME should be the IP address or FQDN that you use for access to your exacqVision Web Service.
  10. Re-start exacqVision Web Server by typing sudo /usr/local/exacq/webservice/service.sh restart.

    NOTE: To connect to exacqVision Web Server using SSL, you must use HTTPS instead of HTTP.

Troubleshooting

If exacqVision Web Service does not start after configuring it for SSL, complete the following steps:

  1. Open the Apache error logs, found by default at /user/local/exacq/webservice/evapache/logs/error_log.
  2. Look for an entry similar to the following:

    [Wed Mar 04 09:08:54.512004 2015] [ssl:emerg] [pid 19116] AH02565: Certificate and private key www.example.com:443:0 from CERTIFCATE_FILE_NAME.crt and KEYFILE_NAME.key do not match AH00016: Configuration Failed
  3. If you see this entry, complete the following steps:

    a.) Run the following commands, replacing the values in all caps with your values:

    openssl.exe x509 -noout -modulus -in PATH_TO_CRT | openssl md5
    openssl.exe rsa -noout -modulus -in PATH_TO_KEY | openssl md5
    openssl.exe req -noout -modulus -in PATH_TO_CSR | openssl md5

    For example:

    openssl.exe x509 -noout -modulus -in ..\conf\certificate.crt | openssl md5
    openssl.exe rsa -noout -modulus -in ..\conf\privateKey.key | openssl md5
    openssl.exe req -noout -modulus -in ..\conf\csr.csr | openssl md5

    b.) Compare the result values from all of the calls. Each resulting string should be identical. If the values do not match, confer with the certificate authority that issued the certificate.


NOTE: Web Sockets communication will not work using SSL encryption for Web Service versions 7.2.0 – 7.2.6.

Workaround

Disable web sockets in the client configuration page of the browser Client.

Resolution

Update to exacqVision Web Service version 8.4 or later.

<br>