Tools

How to configure WHD to backup an external database in WHD 12.7.8 HF1 and higher

This article describes how to configure Web Help Desk (WHD) to run backups to an external database

First published date

3/18/2022 7:33 PM

Last published date

2/21/2025 12:40 AM

Overview

In versions of Web Help Desk 12.7.8 and earlier, one could enter a path to the executable file (such as .bat, .sh, and others) to backup the database at Setup > General > Database. This command would be executed according to the Backup Schedule. 

WHD_database_backup.png

As we keep hardening the application against possible intrusion, the functionality has now been removed from the User Interface and will now have to be added (if used) as a JVM argument going forward.
 

Product section

Web Help Desk

Cause

-

Resolution

Add the JVM Argument -DWHDdatabaseBackupCommand= to the configuration.

For Windows Server, navigate to <WebHelpDesk>/bin/wrapper/conf/, open the wrapper_template.conf file in a text editor, and add the following line in the # Java Additional Parameters section of that file, setting the next sequential number in the list:
    wrapper.java.additional.<NUMBER>=-DWHDdatabaseBackupCommand="ENTER COMMAND HERE"
 Where <NUMBER> is the next proceeding number AND 
Where "ENTER COMMAND HERE" is the desired backup command as specified by the database vendor to when running in command prompt.

Example: "c:\progra~1\mysql\MySQL\MySQL Server 5.7\bin\mysqldump" -u <username> -p <password> -h localhost whd > c:\whd.sql"


For Mac or Linux, navigate to the <WebHelpDesk>/conf/ directory, open the whd.conf file in a text editor, and add the following line at the end of the file:
    JAVA_OPTS="-DWHDdatabaseBackupCommand="ENTER COMMAND HERE"