Submit a ticketCall us

Systems Monitoring for Dummies
Our new eBook will teach you the fundamentals and help you create monitors and alerts that are effective, meaningful, and actionable. Monitoring is more than a checkbox on your to-do list. This free eBook will give you practical advice to help you succeed in all aspects of monitoring – discovery, alerting, remediation, and troubleshooting. Don’t miss out on this indispensable resource for newbies, experienced IT pros, and everyone in between. Register Now.

Home > Success Center > Web Help Desk (WHD) > Enable HTTPS in Web Help Desk

Enable HTTPS in Web Help Desk

Updated June 14, 2017

Overview

This article describes how to enable HTTPS in Web Help Desk by editing the whd.conf file located in the Web Help Desk directory.

You can access the directory from the following locations:

  • Microsoft® Windows Server®:  \Program Files\WebHelpDesk 
  • macOS:  /Library/WebHelpDesk
  • Linux: /usr/local/webhelpdesk

Environment

  • All Web Help Desk versions

Detail

When a web browser submits an HTTPS request to Web Help Desk, the SSL protocol requires Web Help Desk to respond with a certificate to prove the authenticity of the server. To configure your security, enable HTTPS.

To activate HTTPS in Web Help Desk:

  1. Stop Web Help Desk.
  2. Configure the HTTPS listening port to monitor HTTPS requests.
  3. Configure a URL port to monitor URLs generated by Web Help Desk that point back to the application.
  4. Enable Web Help Desk to listen for HTTPS requests.
  5. Enter the SSL connection port (if needed).
  6. Restart Web Help Desk.

The following procedure requires you to modify the whd.conf file. Review the following procedures before you enable HTTPS.

Stop Web Help Desk

To Stop WHD Services, do one of the following:

  • Windows Server: Navigate to the Web Help Desk directory, right-click whd_stop.bat and select Run as Administrator.
  • macOS: Navigate to /Applications/WebHelpDesk and click Stop Web Help Desk or run the following commands in a terminal window:
    cd /Library/WebHelpDesk ./whd stop
  • Linux: Run the following commands in a terminal window:
    cd /usr/local/webhelpdesk/
    sudo ./whd stop

Configure the HTTPS listening port

  1. Open a File Explorer window.
  2. Open the Web Help Desk directory.
  3. Open the /conf directory.
  4. Open the whd.conf file in a text editor (such as Notepad). 
  5. Locate the Ports section.
  6. Enter the port number Web Help Desk monitors for HTTPS requests.
    This port number is located after the following entry:
    HTTPS_PORTS=  
  7. Save and close the whd.conf file.

Configure a URL port

Web Help Desk may require a different port for the URLs it generates to itself than the port used by the application server. For example, you can configure a Web server to route requests for the default port (80) to go to the default Web Help Desk port (8081).

In this example, you can have Web Help Desk URLs use port 80 instead of port 8081.

  1. In the whd.conf file, locate the URL Ports (optional) section.
  2. At the bottom of this section, enter a URL port number after the following entry:
    URL_HTTPS_PORT=
  3. Save and close the file.

Enable listening for HTTPS requests

  1. In the whd.conf file, locate the HTTPS_PORT entry. 
  2. Uncomment the entry.
  3. Save and close the file.

Enter the SSL connection port

By default, web browsers use port 443 for SSL connections. If you use a different port, include the port number in URLs that refer to Web Help Desk.

For example, if the whd.conf file contains HTTPS_PORT=8443, connect to Web Help Desk using the following URL:

https://localhost:8443

Restart Web Help Desk

After you configure the HTTPS_PORT setting, restart Web Help Desk.

  • Windows Server: Navigate to the Web Help Desk directory, right-click whd_stop.bat and select Run as Administrator.
  • macOS: Navigate to /Applications/WebHelpDesk and click Start Web Help Desk or run the following commands in a terminal window:
    cd /Library/WebHelpDesk ./whd start
  • Linux: Run the following commands in a terminal window:
    cd /usr/local/webhelpdesk/
    sudo ./whd start

After the restart, the application creates a new Java keystore at the following location:

WebHelpDesk/conf/keystore.jks

The new keystore contains a self-signed certificate.

 

 

 

Last modified

Tags

Classifications

Public