Tag: Web Service

Categories
Knowledge Support Support exacqVision Webservice Categories Products

What type of video does the exacqVision Web Service transmit?

The codec used to transmit video will depending on the plugin used. In many cases the exacqVision Web Service performs transcoding and transmits a compressed JPEG stream of images to the Web Client or Exacq Mobile 3 app. Some plugins are capable of forwarding the H.264 stream without the need to transcode.

<br>

Categories
Knowledge Support Support exacqVision Client exacqVision Server Categories exacqVision Webservice Products

How do I update my exacqVision software?

exacqVision Applications

exacqVision software can be thought of as a suite of applications that work together to provide different services.

The primary application is the exacqVision Server, which records video, audio, and event data. The exacqVision Client provides an interface to view live and recorded video as well as to configure the server application. A single site may have the exacqVision Client installed on many workstations. The exacqVision Web Service connects to the server application as well to provide the ability to view live and recorded video via web browser or mobile app.

These may be updated using the user interface, or by downloading and manually running installers for the newer version.

When opting to update one of these applications it is not uncommon for users to forget to update the others. This guide will explain how to update each of these applications on both Windows and Linux machines. Use the Contents menu to skip to sections relevant to your installation.<br><br>

exacqVision Client

‘Check for Updates’ using the Client

The exacqVision Desktop Client software for Windows, Linux, and Mac operating systems provides an easy way to update the software using the ‘Check for Updates’ button.

  1. Open the exacqVision Client software.<br><br>
  2. Click the exacqVision logo in the upper corner.
    <br><br>
  3. Click the ‘Check for Updates’ button.

    NOTE: This requires the client workstation to have internet access.<br><br>
  4. Allow the update to download.
    <br><br>
  5. When ready, click the ‘Install’ button.
    <br><br>
  6. The Client installer requires the Client software to be closed during update. Click ‘Yes’ to automatically close the Client application and continue with the update.
    <br><br>
  7. The Client installer will complete and you may reopen the Client application to continue use.

    NOTE: This only updates the Client software on the machine it was performed on. Each client workstation should be updated.<br><br>

Manual Client updates

  1. Navigate to the Software Downloads page at Exacq.com<br><br>
  2. Download the exacqVision Client installer beneath the section for your operating system (Windows, Linux, or MacOS).<br>
    Avoid using the ‘exacqVision Server Bundle’ to update client workstations. You may unintentionally install additional instances of the exacqVision Server and/or Web Service on your network which could lead to user problems.<br>
    NOTE: Only 64-bit installers are provided for current versions here. Refer to Legacy Software Downloads for 32-bit software.<br><br>
  3. Install the new version.
    • Windows:
      • Run the downloaded .EXE executable by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
    • Linux (Ubuntu/Debian):
      • Run the downloaded .DEB installer by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
    • MacOS:
      • Double-click the downloaded .DMG file to open it.
      • Drag the ‘edvrclient’ and ‘ePlayerPro’ icons into the ‘Applications’ folder.<br><br>
  4. On Windows and Linux, follow the prompts to complete the Client software update.
    NOTE: This only updates the Client software on the machine it was performed on. Each client workstation should be updated.<br><br>

Client software deployment

Windows .MSI installers are also provided on the Software Downloads page for those users that need to provide software deployments.<br><br>

exacqVision Server

Before Server Update – Best Practice

Prior to making changes to your server installation, it is best practice to export a copy of your server’s settings.

  1. Open the exacqVision Client application and change to the Configuration screen by clicking the gear icon from the upper-left of the toolbar.<br><br>
  2. You will need to be connected to the exacqVision Server with administrator privileges. Logged in user accounts can be changed by navigating to the ‘Add Systems’ page and highlighting the server of your choice then changing the ‘Username’ and ‘Password’ used to connect.<br><br>
  3. While logged in with administrator privileges, use the navigation panel on the left-hand side to expand the tree under the name of your server by clicking the + symbol beside the server name.<br><br>
  4. Click on the ‘Configure System’ node beneath it.
    <br><br>
  5. Select the ‘System’ tab and locate the ‘Settings’ section. Click the ‘Export’ button to save your server’s settings for safe keeping. If keeping several backups, it may be helpful to name the exported files with the date the export was performed.
    <br><br>

‘Check for Updates’ on Server

  1. Open the exacqVision Client application and change to the Configuration screen by clicking the gear icon from the upper-left of the toolbar.<br><br>
  2. You will need to be connected to the exacqVision Server with administrator privileges. Logged in user accounts can be changed by navigating to the ‘Add Systems’ page and highlighting the server of your choice then changing the ‘Username’ and ‘Password’ used to connect.<br><br>
  3. While logged in with administrator privileges, use the navigation panel on the left-hand side to expand the tree under the name of your server by clicking the + symbol beside the server name.<br><br>
  4. Click on the ‘Configure System’ node beneath it.
    <br><br>
  5. Select the ‘Update’ tab from the list of tabs across the top of the ‘Configure System’ page. The tab displays the current exacqVision Server version and provides a ‘Check for Updates’ button.
    <br><br>
  6. Click the ‘Check for Updates’ button.
    NOTE: This requires the system running the exacqVision Server application to have internet access.<br><br>
  7. The Version drop-down menu will populate with all available versions, automatically choosing the latest version that your system is licensed to use.

    NOTE: If your server license is expired, only versions released prior to your license expiration date will be available to you.<br><br>
  8. After making the version selection, click the ‘Update’ button.

    NOTE: The server will go offline during this process and pause recording during that time. This could take several minutes depending on your system. Click ‘Continue’ to accept.<br><br>
  9. The server will begin the process of downloading the update and installing the new version.



    The Client software will reconnect to the Server once the update has completed and the service returns.<br><br>

Manual Server updates

  1. Navigate to the Software Downloads page at Exacq.com<br><br>
  2. Download the exacqVision Server installer beneath the section for your operating system (Windows, Linux).<br>
    NOTE: Only 64-bit installers are provided for current versions here. Refer to Legacy Software Downloads for 32-bit software.<br><br>
  3. Install the new version.
    • Windows:
      • Run the downloaded .EXE executable by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
    • Linux (Ubuntu/Debian):
      • Run the downloaded .DEB installer by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
  4. Follow the prompts to complete the Server software update.
    NOTE: This only updates the Server software on the machine it was performed on. Client software is unaffected. See Client updates section for more.<br><br>

exacqVision Web Service

‘Check for Updates’ in Web Service

  1. Open a web browser and navigate to the Web Service landing page. By default the Web Service uses port 80, so using the browser on the system running the exacqVision Web Service, it can be reached at http://127.0.0.1<br><br>
  2. On the landing page, a link for ‘Web Service Configuration’ can be found in the lower corner. Click this link.

    NOTE: If you cannot see this, you may not be using the browser on the system running the Web Service, and/or the configuration settings to display this link may have been changed.<br><br>
  3. Log into the Web Service Configuration using the administrator account configured for the web service.<br><br>
  4. From the left-hand side, expand the ‘Configuration’ menu, then select ‘Updates’.
    <br><br>
  5. Click the ‘Check For Updates’ button. You will be notified if an update to your existing version exists. Click to ‘Install’ the update.
    <br><br>
  6. Confirm the install.

    NOTE: The web service will be unreachable by your site’s web and mobile users during the software update, which could take several minutes.<br><br>
  7. The Web Service will restart when the update has finished.
    <br><br>

Manual Web Service updates

  1. Navigate to the Software Downloads page at Exacq.com<br><br>
  2. Download the exacqVision Web Service installer beneath the section for your operating system (Windows, Linux).<br>
    NOTE: Only 64-bit installers are provided for current versions here. Refer to Legacy Software Downloads for 32-bit software.<br><br>
  3. Install the new version.
    • Windows:
      • Run the downloaded .EXE executable by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
    • Linux (Ubuntu/Debian):
      • Run the downloaded .DEB installer by double-clicking it. Unless you’ve changed the download location, it will likely be located in your Downloads directory.
  4. Follow the prompts to complete the Web Service software update.
    NOTE: This only updates the Web Service software on the machine it was performed on.<br><br>

<br>

Categories
Knowledge Support Highlighted Support exacqVision Webservice Categories Products

Using SSL with exacqVision Web Service (Windows)

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.

NOTE: 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 in Windows with exacqVision Web Service, complete the following steps:

  1. Either create a self-signed certificate, or purchase a certificate from a trusted third party. (Creating a Self-Signed SSL Certificate) COMMON NAME should be the IP address or FQDN that you use to access your exacqVision Web Service. If acquiring a third-party cert, you might need to provide them with a Certificate Signing Request (CSR) file as follows:

    a. Navigate to https://exacq.com/support/gencsr.php.

    b. Enter all fields to output a .csr file and RSA key file to a zip file. Submit this data to the CA from which you are purchasing the certificate.

    c. If you have purchased a chained certificate, be sure to download the appropriate intermediate bundle.

    d. Place the .crt file and the intermediate bundle file (also a .crt file) from your CA into the Apache\conf directory.
  2. Rename the .crt file to server.crt and the .key file to server.key. Save the .crt and .key files to C:\Program Files (x86)\exacqVision\WebService\Apache\conf\.
  3. Stop exacqVision Web Server using the link on the Start menu.
  4. Open the Web Server Configuration file with Notepad as an administrator from C:\Program Files (x86)\exacqVision\WebService\Apache\conf\httpd.conf.

    Find the following line:

    LoadModule ssl_module modules/mod_ssl.so

    Delete any preceding pound sign (#) characters.

    Find the following line:

    Include conf/extra/httpd-ssl.conf

    Delete any preceding pound sign (#) characters.

    NOTE: Make sure your SSL Certificate File and SSL Certificate Key File are in the Apache\conf directory.
  5. Open the Apache SSL Configuration file in Notepad as an administrator. The file is located at C:\Program Files (x86)\exacqVision\WebService\Apache\conf\extra\httpd-ssl.conf.
    Find the line that begins with:
    FilesMatch “…

    Change it to:

    FilesMatch “\.(cgi|shtml|phtml|php|html)$”

    NOTE:     Those lines will also include angle brackets. Do not remove the brackets.

    When finished, save and close the file.
  6. 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 in Notepad as an administrator. The file is located at C:\Program Files (x86)\exacqVision\WebService\Apache\conf\extra\httpd-ssl.conf. 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.
  7. Open the Web Service Configuration file in Notepad as an administrator. The file is located at C:\Program Files (x86)\exacqVision\WebService\WebService.ini.
    Add the following lines to the end of the document:

    [Broker]
    ssl_private_key = C:\Program Files (x86)\exacqVision\WebService\Apache\conf\server.key
    ssl_certificate = C:\Program Files (x86)\exacqVision\WebService\Apache\conf\server.crt

    When finished, save and close the file.
  8. Open an exception for TCP port 443 in your firewall.
  9. Start exacqVision Web Server using the link under the Start button.

<br>

Tips

  1. When purchasing an SSL certificate, many providers offer an Intermediate Bundle, or additional certificates that need to be present that will link your certificate through the chain to a root certification authority. Usually the provider will also provide documentation that describes how to accomplish this with Apache, but is a good idea to ask them before or during the purchase process. Exacq is not responsible for making your certs capable of working with Apache.
  2. The httpd-ssl.conf file contains sections for Server Certificate, Server Private Key, Server Certificate Chain, and Certificate Authority. You must modify these sections with the appropriate paths to your specific files.
  3. It is possible to combine all the intermediate certificates that the provider might give you into one file and use that in the Server Certificate Chain section. Again, consult the provider for more information.
  4. You should also find and modify the following line to include the name for which your certificate was issued (your server’s name) instead of:

    ServerName www.example.com:443

<br>

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 C:\Program Files\exacqVision\WebService\Apache\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 openssl utility (found by default at C:\Program Files\exacqVision\WebService\Apache\bin\openssl.exe).

    b.) 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

    c.) 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.

<br>

Workaround

Disable Web Sockets in the client configuration page of the browser Client.

<br>

Resolution

Update to exacqVision Web Service version 8.4 or later.

<br>