Documentation forWeb Help Desk

Upgrade the PostgreSQL database in an existing deployment

If you are upgrading WHD from version 12.7.6 and earlier, you can upgrade your existing PostgreSQL database to version 13.3 using the database upgrade utility included with the WHD 12.7.8 release. When you run the utility, it stops the PostgreSQL service, upgrades the database to version 13.3, and then restarts the PostgreSQL service. When the upgrade is completed, the utility automatically opens WHD, allowing you to log in to the application.

When you run the utility on a system running Microsoft Windows, the utility creates a new local user named PostgreWHD in the Computer Management > Local Users and Groups > Users directory. This user role is integrated with the PostgreSQL 13.3 upgrade configuration and cannot be deleted.

The default whd role is deleted during the upgrade procedure. This ensures that all unauthorized users cannot access the database.

Before you upgrade

Perform the following mandatory procedures on the WHD system:

  1. Back up your WHD database.

    1. Log in to WHD as an administrator.

    2. Click Setup > Database.

    3. In the Database Connection window, click Backup Now.

  2. Change the default PostgreSQL database credentials.

    The upgrade procedure deletes the default whd user in WHD. Before you upgrade to PostgreSQL 13.3, be sure to change your default PostgreSQL database credentials. Otherwise, you cannot log in to WHD after the upgrade.

Perform the upgrade

Run the upgrade utility based on your Windows, Linux, or macOS operating system. When the upgrade is completed, the utility creates an upgrade.output.log file that lists the actions taken during the upgrade procedure. You can access the log file in the <WebHelpDesk>/log directory.

Upgrade the database on a Windows system

Perform the following steps on a WHD server running a supported Microsoft Windows or Windows Server operating system.

  1. Log in to the WHD server as an administrator.
  2. If the host system is not running Windows Server 2012 R2, go to step 3.

    If the host system is running Windows Server 2012 R2, download Windows Management Framework (WMF) 5.1 from the Microsoft Download Center and install the software on your system.

  3. Navigate to the <WebHelpDesk>\bin folder.

    The default location is:

    \Program Files\WebHelpDesk\bin

  4. Run the upgradeDatabase.bat file.

    A PowerShell window displays the upgrade process. Multiple command windows may also display during the upgrade.

    When the process is completed, the WHD interface displays a message, stating that the embedded PostgreSQL database is up to date.

  5. Click Continue.

    When the upgrade is completed, WHD opens.

  6. In the Log In window, enter your administrator credentials, and then click Log In.

    The WHD web console displays on the screen.

Upgrade the database on a Linux system

Perform the following steps on a WHD server running a supported Red Hat Enterprise Linux (RHEL), CentOS, or Fedora operating system.

  1. Log in to the WHD server as an administrator.

  2. Open a Command window.

  3. Log in as root.

  4. Run the databaseUpgrade utility located in the <WebHelpDesk>/bin directory.

    In the Command window, execute:

    sudo /usr/local/webhelpdesk/bin/databaseUpgrade

    The Command window displays the upgrade process.

    When the process is completed, the WHD interface displays a message, stating that the embedded PostgreSQL database is up to date.

  5. Click Continue.

    When the upgrade is completed, WHD opens.

  6. In the Log In window, enter your administrator credentials, and then click Log In.

    The WHD web console displays on the screen.

Upgrade the database on a macOS system

Perform the following steps on a WHD server running a supported macOS operating system.

  1. Log in to the WHD server as an administrator.

  2. Using the Finder, navigate to Applications > Utilities > Terminal and open the Terminal application.

  3. In the Terminal window, log in as root.

  4. Modify the kernel parameters to allocate additional shared memory to the new PostgreSQL database. This will prevent database errors when the utility initializes the database.

    Execute: 

    sysctl -w kern.sysv.shmmax=33554432

    sysctl -w kern.sysv.shmmin=1

    sysctl -w kern.sysv.shmmni=256

    sysctl -w kern.sysv.shmseg=64

    sysctl -w kern.sysv.shmall=8192

  5. Navigate to the <WebHelpDesk>/bin directory.

    The default location is:

    /Library/WebHelpDesk/bin

  6. Run the databaseUpgrade utility.

    The Terminal window displays the upgrade process.

    When the process is completed, the WHD interface displays a message, stating that the embedded PostgreSQL database is up to date.

  7. Click Continue.

    When the upgrade is completed, WHD opens.

  8. In the Log In window, enter your administrator credentials, and then click Log In.

    The WHD web console displays on the screen.