Documentation forWeb Help Desk

Install WHD in a stand-alone deployment

This section describes how to perform a WHD stand-alone installation on a dedicated server.

For advanced configuration requirements and steps such as Federal Information Processing Standard (FIPS) 140-2 compliant cryptography, see the WHD Administrator Guide.

Prepare for the install

Before you install WHD, do the following:

  1. Locate the external database credentials.

    If you plan to use SQL Server or MySQL for your primary database, locate the following:

    • IP address or host name and port of the database server
    • Database name
    • Database user name and password
  2. Check your administrator account credentials.

    • Use an account with local administrative rights.
    • Verify that the account is not subject to any local or group policy restrictions.
  3. If your WHD server is running Microsoft Windows Server 2012 R2, download Windows Management Framework (WMF) 5.1 from the Microsoft Download Center and install the software on your system.

Install WHD

You can install WHD on a server running one of the following operating systems:

Install WHD on a server running Microsoft Windows Server

To install a production or evaluation copy of WHD on a server running a supported Windows Server operating system:

  1. Download the installer from the Customer Portal.
    1. Quit all other programs.
    2. Log in to the WHD server as an administrator.
    3. Log in to the Customer Portal.
    4. Click Downloads > Download Product.
    5. Click the Products drop-down menu and select Web Help Desk (WHD).
    6. Click the Licenses drop-down menu and select your license tier.
    7. Download Server for Windows 64-bit.
  2. Extract the contents of the ZIP file.

    The WebHelpDesk-12.7.x-x64.zip file includes the following files:

    • WebHelpDesk-12.7.x.x64.exe, which installs WHD and the latest hotfix (if available) on a stand-alone 64-bit server.
    • WHD-12.7.x.xxxx-Hotfix, which contains the latest hotfix files (if available).
  3. Run the installation file.
    1. Right-click webhelpdesk-12.7.x.64.exe and select Run as Administrator.
    2. Complete the on-screen instructions.
    3. When the installation is complete, click Done.

      The Configuration Wizard opens the default browser.

  4. Complete the installation.

Install WHD on a server running Mac OS X or macOS

To install a production or evaluation copy of WHD on a server running a supported macOS operating system:

  1. Download the installer from the Customer Portal.
    1. Log in to the WHD server as an administrator.
    2. Quit all other programs.
    3. Log in to the Customer Portal.
    4. Click Downloads > Download Product.
    5. Click the Products drop-down menu and select Web Help Desk (WHD).
    6. Click the Licenses drop-down menu and select your license tier.
    7. Download Server for macOS.
  2. Extract the contents from the ZIP file.

    The ZIP file includes the following files:

    • webhelpdesk-12.7.x.64.pkg, which installs WHD and the latest hotfix (if available) for a standalone server.
    • WHD-12.7.x.xxxx-Hotfix, which contains the latest hotfix files (if available).
  3. Run the installation file.
    1. Double-click webhelpdesk-12.7.x.64.pkg.
    2. Complete the on-screen instructions.
    3. When the installation is complete, click Done.

      The Configuration Wizard opens the default browser.

  4. Complete the installation.

Install WHD Desk on a server running Red Hat Linux 64-bit

To install a production or evaluation copy of WHD on a server running Red Hat Linux:

  1. Download the installation file from the Customer Portal.
    1. Quit all other programs.
    2. Log in to the WHD server as an administrator.
    3. Log in to the Customer Portal.
    4. Click Downloads > Download Product.
    5. Click the Products drop-down menu and select Web Help Desk (WHD).
    6. Click the Licenses drop-down menu and select your license tier.
    7. Download Server for RedHat Linux 64-bit.
  2. Extract the files from the gzip file.
    1. Extract the contents of the WebHelpDesk-12.7.x.xxxx.x86_64.rpm.gz file.
    2. Open a terminal window and execute:

      gunzip webhelpdesk-12.7.X.x86_64.rpm

      The unzipped file includes the following file:

      webhelpdesk-12.7.x.xxxx.x86_64.rpm

      This file installs WHD for a standalone server.

  3. Run the installation file.
    1. Open a terminal window and execute:

      rpm -ivh webhelpdesk-12.7.X.x86_64.rpm

    2. Open a web browser and navigate to:

      https://127.0.0.1:8443

      Secure port 8443 is the default port. If you log in using unsecure port 8081, a warning displays on the screen, indicating that the connection is not private.

      The Configuration Wizard displays on the screen.

  4. Complete the installation.

Complete the installation

When the installation is completed, the Configuration Wizard runs on secure port 8443 in the default browser. Complete the wizard, and then enable and configure the 64-bit Java Virtual Machine (JVM) memory on the WHD server (if applicable).

If you log in using unsecure port 8081, the installer displays a warning message, indicating that the connection is not private.

  1. If prompted to set up Internet Explorer security settings, select an option, and click OK.

  2. Select a database for your WHD installation.

    To create a custom SQL database on a host running Microsoft SQL Server, go to step 3.

    To create an embedded PostgreSQL database on your WHD server, go to step 4.

  3. If WHD will be configured with an SQL Server database, set up the custom SQL database.

    1. Select Use Custom SQL database (advanced).

    2. (Optional) To create an account on your SQL Server database, click Create database and user account if necessary, enter the admin user name and password, and then click Create.

    3. Click the Database Type drop-down menu and select Microsoft SQL Server 2008+.

    4. In the Host field, enter the IP address or hostname of the SQL database server.

    5. In the Port field, enter the SQL server port number. The default port is 1433.

    6. In the Database Name field, enter the name of the SQL database instance.

    7. In the Username field, enter the name of your local SQL account.

    8. In the Password field, enter the password of your local SQL account.

    9. Click Test to test the database connection.

      WHD creates the SQL database for your deployment.

      When the procedure is completed, the installer displays the following message: 

      If Results displays an error, follow the instructions on your screen, make the necessary changes, and then click Create.

    10. Click Next.
    11. Go to step 5.
  4. Configure the embedded PostgreSQL database for your deployment. 
    1. Select Use Embedded PostgreSQL database (recommended).

    2. In the Database Name field, enter a name for the PostgreSQL database.

      The database name must:

      • Contain no more than 50 characters.

      • Begin with an upper-case letter (A-Z) or a lower-case letter (a-z) using letters and numbers as the remaining characters

      • Not include postgres, template0, or template1

    3. In the Username field, enter a username.

      The username must:

      • Contain no more than 50 characters

      • Begin with an upper-case letter (A-Z) or a lower-case letter (a-z) using letters and numbers as the remaining characters

      • Not include whd or postgres.

    4. In the Password field, enter a password for the PostgreSQL database.

      SolarWinds recommends creating a password that includes: 

      • At least nine characters up to 50 characters

      • At least two upper-case letters

      • At least two lower-case letters

      • At least two numbers

      • At least two of the following special characters:

        ‘ ~ ! @ # $ % ^ & * ( ) _ - + = { } [ ] \ / < > , . ; ? ' : | (space)

    5. In the Admin username field, enter a username for the PostgreSQL administrator. This administrator will manage the PostgreSQL database.

      The username must:

      • Contain no more than 50 characters

      • Begin with an upper-case letter (A-Z) or a lower-case letter (a-z) and include subsequent letters and numbers

      • Not include whd or postgres

    6. In the Admin password field, enter a password for the administrator account.

      SolarWinds recommends creating a password that includes: 

      • At least nine characters up to 50 characters maximum

      • At least two upper-case letters

      • At least two lower-case letters

      • At least two numbers

      • At least two of the following special characters:

        ‘ ~ ! @ # $ % ^ & * ( ) _ - + = { } [ ] \ / < > , . ; ? ' : | (space)

    7. Click Create.

      WHD creates the PostgreSQL database for your deployment.

      When the procedure is completed, the installer displays the following message: 

      If Results displays an error, follow the instructions on your screen, make the necessary changes, and then click Create.

    8. Click Next.

  5. Set up the email accounts.

    1. Complete the fields as required to configure the incoming email account and outgoing server.

      Each incoming mail account is associated with a specific request type, an optional tech group, and an outgoing mail account (SMTP server) used to deliver outgoing mail. For example, you could have an incoming mail account for all IT tickets, another account for HR tickets, and another for Facilities tickets.

      WHD checks the Incoming mail accounts each minute for new messages, processes the messages into tickets, and deletes the processed messages from the incoming mail server.

      If you are not ready to set up the email accounts, you can skip this step and set up the email accounts later from the WHD Web Console. To continue without configuring email, click Skip this step and go to step 6.

    2. Expand Advanced to set up the incoming mail ports.

      The installer displays the incoming mail ports menu.

    3. In the Incoming Mail Port field, enter the port number for incoming mail.

      By default, WHD uses your first configured incoming mail account request type as the default. After you complete the Getting Started Wizard, you can update your email account information at Setup > E-Mail.

    4. In the SMTP port field, enter the port number for outgoing mail.
    5. Complete the remaining fields and check boxes as required.
    6. Click Test to test your email address.

      If the email connection is good, the installer displays a confirmation message.

      If the email connection is not good, verify the Test Email Addresses field value and then click Test.

    7. Click Next to continue.
  6. Complete the fields to create the default admin account.

    The default admin account is a local super user account used to:

    • Log in to WHD for the first time and configure the application.
    • Access all WHD settings and accounts.

    Administrators with a default admin account can create all user accounts, including additional admin accounts. The default admin account includes tech account privileges, so you can create and process tickets with tech privileges. Techs can have either Tech or Tech Admin account privileges.

  7. Click Next to continue.

  8. (Optional) Create one or more custom request types.

    When you install WHD, the last step of the WHD Getting Started wizard allows you to add request types or edit preconfigured request types. This step of the wizard is optional.

    You may find it easier to add request types in the Tickets panel after WHD is configured.

    SolarWinds recommends that you click Finish to bypass this step in the wizard and take time to plan the request types you need. See Create tech groups and request types in the WHD Getting Started Guide for information about creating request types.

  9. Click Finish.

    The Configuration Wizard applies your settings and configures the application.

    This process may take several minutes to complete.

  10. Click Login as admin to continue the setup.

    The Wizard opens the WHD Administrator Console on port 8443 using HTTPS.

    WHD is installed on your server.

    If you log in to WHD and receive an HTTP Status 404 error, see HTTP Status 404: The requested resource () is not available to resolve this issue.

  11. In the Log In box, enter your administrator email and password, and then click Log In.
  12. Review the End User License Agreement. If you agree with the license agreement, accept the terms and click Continue.

    The WHD Administrator Console displays on your screen.

  13. (PostgreSQL database only) Change the default PostgreSQL database password.

Enable the 64-bit JVM memory

WHD requires additional max heap memory over the Java Virtual Machine (JVM) default setting. To improve application performance, enable the 64-bit JVM memory in the whd.conf file. When you are finished, increase the MAXIMUM_MEMORY value in the whd.conf file based on the number of techs in your deployment, and then restart the application.

  1. On the WHD server, navigate to the WHD conf directory based on your operating system.

    • macOS: /Library/WebHelpDesk/conf
    • Microsoft Windows: \Program Files\WebHelpDesk\bin\wrapper\conf
    • Linux: /usr/local/webhelpdesk/conf
  2. If you are running Windows, go to step 3.

    If you are running macOS or Linux, do the following:

    1. In the conf directory, open the whd.conf file using a text editor (such as Notepad).
    2. Add the following argument to the JAVA_OPTS option:

      JAVA_OPTS="-d64"

    3. Save your changes.

    4. Go to step 4.

  3. If you are running Windows, do the following:

    1. In the conf directory, open the wrapper_template.conf file using a text editor (such as Notepad).

    2. Scroll down to the Java Additional Parameters section.

    3. At the end of the parameter list, add the following parameter:

      wrapper.java.additional.xx=-d64

      where xx is the next corresponding parameter number.

    4. Save the file.

    5. Restart Web Help Desk.

      1. Click Setup > General > System Information.

      2. Click Restart Web Help Desk.

    6. Log in as an administrator.

  4. Increase the JVM memory.

    1. Determine the appropriate amount of memory for your deployment using the following formula:

      (Average number of concurrent techs x 150) + (Average number of concurrent users x 25) = MAXIMUM_MEMORY value

      For example, If the average number of concurrent techs is 10 and the average number of concurrent users is 50, the recommended MAXIMUM_MEMORY value is 2750 (which is 2.75 GB):

      (10 x 150 = 1500) + (50 x 25 = 1250) = 2750

      The MAXIMUM_MEMORY value should not be greater than the total memory in the WHD server.

    2. Update the whd.conf file for your Microsoft Windows Server, macOS, or Linux operating system.

Microsoft Windows Server

  1. Navigate to the <WebHelpDesk>/conf directory.

    The default directory is located at:

    C:\Program Files\WebHelpDesk\

  2. Open the \conf directory.
  3. Open the whd.conf file in a text editor (such as Notepad).
  4. In the whd.conf file, locate the MAXIMUM_MEMORY parameter.

  5. Change the parameter value to the value you calculated in an earlier step.
  6. Save and close the file.
  7. Restart Web WHD.
    1. In the WebHelpDesk directory, right-click whd_stop.bat and select Run as Administrator.
    2. After the command prompt window closes, right-click whd_start.bat and select Run as Administrator.

macOS

  1. Using Finder, navigate to Applications > Utilities > Terminal and open the Terminal application.
  2. Change the directory to the <WebHelpDesk>/conf directory:

    cd /Library/WebHelpDesk/conf

  3. Open the whd.conf file by executing:

    sudo vi whd.conf

  4. Enter the following command to change the maximum JVM to the value you calculated in a previous step:

    :%s/MAXIMUM_MEMORY=512/MAXIMUM_MEMORY=[memory in MB]/ :wq

    For example, if you would like to use 2750 MB, execute:

    :%s/MAXIMUM_MEMORY=512/MAXIMUM_MEMORY=2750/ :wq

  5. Save and close the file.
  6. Restart WHD.

    1. Open a terminal window and execute:

      sudo /Library/WebHelpDesk/whd stop

    2. In the terminal window, execute:

      sudo /Library/WebHelpDesk/whd start

Linux

  1. Open a terminal window
  2. Change the directory to the <WebHelpDesk>/conf directory.

    Type:

    cd /usr/local/webhelpdesk/conf

  3. Open the whd.conf file.

    Type:

    sudo vi whd.conf

  4. Change the maximum JVM to the appropriate value.

    Execute:

    :%s/MAXIMUM_MEMORY=512/MAXIMUM_MEMORY=[memory in MB]/ :wq

    For example, if you want to change the value to 2750 MB, type:

    :%s/MAXIMUM_MEMORY=512/MAXIMUM_MEMORY=2750/ :wq

  5. Save and close the file.
  6. Restart WHD.

    1. In the terminal window, execute:

      sudo service webhelpdesk stop

    2. In the terminal window, execute:

      sudo service webhelpdesk start