Categories
Knowledge Support Support Categories exacqVision Webservice Products

Manually Configuring HTTPS for Web Service Certificate and Key Path

The following steps are intended for manually setting the certificate and key path for exacqVision Web Service versions 8.4 and higher.

NOTE: Wildcard certificates cannot be uploaded through the exacqVision Web Service administration interface. However, they may be used when manually configured.

<br>

Products

  • exacqVision Web Service version 8.4 and above

<br>

Steps

  1. Find the web service configuration file:
    • Windows:  C:\ProgramData\Webservice\conf\wfe.json
    • Linux:  /etc/webservice/wfe.json<br><br>
  2. Open this JSON configuration file with the text editor of your choice.
    • Windows: Open the text editor choosing, ‘Run as Administrator’
    • Linux: Run with sudo privileges when needed.<br><br>
  3. Within this file, locate the top-level key ‘webserver’.<br><br>
  4. One level underneath the ‘webserver’ key, locate the ‘tls’ key.
    • Note: The ‘tls’ key is optional. If it does not exist, create it as such:
          "webserver": {
              "listen": 80,
              "tls": {
              }<br><br>
  5. Inside the ‘tls’ key, modify the values for the following fields (creating keys for them if they are not already present)
    • “type”:  The literal string “external” (including the quotes)
    • “listen”:  The port on which you want the web service to conduct HTTPS traffic. The default HTTPS port is 443. Provide this value as a literal number without quotes.
    • “cert”:  The absolute path to your HTTPS certificate (surrounded in double-quote markers, e.g. “/home/admin/certificates/webservice.cert”)
    • “key”:  The absolute path to your HTTPS private key (surrounded in double-quote markers as well)

      If you have followed these steps correctly, the contents of webserver key section of the wfe.json should now look something like the following:
          "webserver": {
              "listen": 80,
              "tls": {
                 "listen": 443,
                 "cert": "path/to/your/cert",
                 "key": "path/to/your/key",
                 "type": "none"
              }<br><br>
  6. Save your changes.<br><br>
  7. Restart the exacqVision Web Service.

<br>