Migrate Web Help Desk to a new server

Migrating Web Help Desk to a different server requires you to move the current Web Help Desk installation settings files to the new server and relink the application to your database.

You can move Web Help Desk to another server in the following configurations:

Access a command line

Most of the commands in this article must be executed in a command line. The following table describes how to open a command line in your operating system.

Operating System Steps
Windows Server
  1. Open a Run dialog box.
  2. Enter cmd to open a command line with administrator privileges.
macOS
  1. Click Applications >Utilities.
  2. Double-click Open in Terminal.

    This option may vary with your distribution.

Linux

(RPM installation)

  1. Open the graphical user interface.
  2. Click Applications > System.
  3. Right click Desktop and click Open in Terminal.

Web Help Desk directory

In the following procedures, <WebHelpDesk> represents the Web Help Desk home folder. The default home folders for the supported operating systems are listed below.

If you installed Web Help Desk in a non-standard directory, replace the following paths with the correct locations in all commands.

Operating System Path
Windows Server

\Program Files\WebHelpDesk

macOS

/Library/WebHelpDesk

Linux

/usr/local/webhelpdesk

Both servers are running identical operating systems

  1. Ensure that both servers are running identical 32-bit or 64-bit operating systems.
  2. Log in to Web Help Desk as an administrator.
  3. Click Setup > General > License.
  4. Click the padlock next to your license.
  5. In the License Settings screen, click Deactivate to deactivate your license.
  6. Log out of the Web Help Desk Administrator Console.
  7. Stop Web Help Desk on the original server.
  8. Navigate to the <WebHelpDesk> directory.

    Operating System Path
    Windows Server

    \Program Files\WebHelpDesk

    macOS

    /Library/WebHelpDesk

    Linux

    /user/local/webhelpdesk

  9. Back up the <WebHelpDesk>\conf directory to a safe location.
  10. If the original server is running Windows Server, copy the \bin\wrapper\conf directory to a safe location.
  11. Install the same Web Help Desk version on the target server.
  12. On the target server, initialize Web Help Desk using the Getting Started Wizard.

    When prompted, select Embedded database (the default is PostgreSQL).

  13. On the target server, stop Web Help Desk and the PostgreSQL service.
  14. On the target sever, rename the \Program Files\WebHelpDesk\PGSQL9 directory to OLD_PGSQL9.
  15. Move the directory to a different location.
  16. Copy the program files in the <WebHelpDesk?\PGSQL9 directory from the old Web Help Desk installation to \Program Files\WebHelpDesk\ on the target server.
  17. On the target server, navigate to the conf directory.
    1. Windows Server: <WebHelpDesk>\bin\wrapper\conf
    2. Linux and macOS: <WebHelpDesk>/conf
  18. Copy the conf directory files from the original server to the same location on the target server.

    Operating System Files
    Windows Server

    keystore.jks

    whd.conf

    labels\CustomLabels*.properties

    bin\wrapper\conf\wrapper_template.conf

    Linux

    macOS

    keystore.jks

    whd.conf

    labels/CustomLabels*.properties

  19. Start Web Help Desk on the target server.

    If the target server domain host name is identical to the original server domain host name, you are finished.

    If the target server domain host name is different from the original server domain host name, perform the following steps:

    1. Log in to Web Help Desk as an administrator.
    2. Click Setup > General > Options.
    3. In the Server DNS Name field, enter the new server DNS name.
    4. Click Save.
  20. Log in to the Web Help Desk Administrator Console as an administrator.
  21. Click Setup > General > License.
  22. Reactivate your license.

Original server is running Windows Server and the target server is running Linux or macOS

  1. Ensure that both servers are running identical 32-bit or 64-bit operating systems.
  2. Log in to Web Help Desk as an administrator.
  3. Click Setup > General > License.
  4. Click the padlock next to your license.
  5. In the License Settings screen, click Deactivate to deactivate your license.
  6. Log out of the Web Help Desk Administrator Console.
  7. Start Web Help Desk on the original server.
  8. Back up the following directories to a safe location:
    • <WebHelpDesk>/conf
    • whd\bin\wrapper\conf
  9. Install an identical Web Help Desk version on the target server.
  10. Initialize Web Help Desk using the Getting Started Wizard.

    When prompted, select the default PostgreSQL embedded database.

  11. Log in to Web Help Desk using admin/admin credentials.
  12. Click Setup > General > Database.
  13. Point Web Help Desk to your original database.

    If the original server connected to an embedded PostgreSQL database, use port 20293.

  14. Start Web Help Desk on the target server.
  15. Navigate to the conf directory on the target server.

    Operating System Path
    Windows Server

    <WebHelpDesk>\bin\wrapper\conf

    Linux

    macOS

    <WebHelpDesk>/conf

  16. Copy the following files from the original server to the same location on the target server:
    • keystore.jks
    • whd.conf
    • labels/CustomLabels*.properties
  17. If you use custom VM arguments in the \bin\wrapper\conf\wrapper_template.conf file, add them to the JAVA_OPTS parameter in the /conf/whd.conf file.

    For example:

    JAVA_OPTS="-Darg1=true -Darg2=true"

  18. Start Web Help Desk on the target server.

    If the target server domain host name is identical to the original server domain host name, you are finished.

    If the target server domain host name is different from the original server domain host name, perform the following steps:

    1. Log in to Web Help Desk as an administrator.
    2. Click Setup > General > Options.
    3. In the Server DNS Name field, enter the new server DNS name.
    4. Click Save.
  19. Log in to the Web Help Desk Administrator Console as an administrator.
  20. Click Setup > General > License.
  21. Reactivate your license.

Original server is running Linux or macOS and target server is running Windows Server

  1. Log in to Web Help Desk as an administrator.
  2. Click Setup > General > License.
  3. Click the padlock next to your license.
  4. In the License Settings screen, click Deactivate to deactivate your license.
  5. Log out of the Web Help Desk Administrator Console.
  6. Stop Web Help Desk on the original server.
  7. Navigate to the <WebHelpDesk> directory.
  8. Back up the <WebHelpDesk>/conf directory to a safe location.
  9. Install an identical Web Help Desk version on the target server.
  10. Initialize Web Help Desk using the Getting Started Wizard.

    When prompted, select the default PostgreSQL embedded database.

  11. Log in to Web Help Desk using admin/admin credentials.
  12. Click Setup > General > Database.
  13. Point Web Help Desk to your original database.

    If the original server used embedded PostgreSQL, use port 20293.

  14. Stop Web Help Desk on the target server.
  15. Navigate to the conf directory on the target server.

    Operating System Path
    Windows Server

    <WebHelpDesk>\bin\wrapper\conf

    Linux

    macOS

    <WebHelpDesk>/conf

  16. Copy the following files from the original server to the same location on the target server:
    • keystone.jks
    • whd.conf
    • labels/CustomLabels*.properties
  17. If you used custom VM arguments in the JAVA_OPTS parameter in the /conf/whd.conf file, add them to the \bin\wrapper\conf\wrapper_template.conf file.

    For example:

    wrapper.java.additional.16=-DWHDconfig=...Helpdesk.woa.properties

  18. If the target server domain host name is identical to the original server domain host name, you are finished.

    If the target server domain host name is different from the original server domain host name, perform the following steps:

    1. Log in to Web Help Desk as an administrator.
    2. Click Setup > General > Options.
    3. In the Server DNS Name field, enter the new server DNS name.
    4. Click Save.
  19. Log in to the Web Help Desk Administrator Console as an administrator.
  20. Click Setup > General > License.
  21. Reactivate your license.