Install WHD with an external PostgreSQL database

During the installation procedure, you can select the embedded PostgreSQL database as your primary database. This database is installed on your WHD server.

WHD also supports PostgreSQL 13.7 and 14.3 as external databases. If you choose to install a PostgreSQL database on an external server, perform the procedures in this section. When you are finished, back up the database.

Set up the external server

1. Download and install PostgreSQL 13.7 or 14.3 on the external server.

   See the PostgreSQL website for instructions.

2. Ensure that the external server can communicate with the Web Help Desk server in your Enterprise network.

Install Web Help Desk

1. Log in to the WHD as an administrator.

2. Install the application on the WHD server.

   See Install WHD in a stand-alone deployment for instructions.

3. When the following window displays, STOP. Leave this window open.

   

Configure Web Help Desk with the external server

1. On the Web Help Desk server, open a File Explore window and navigate to:

   C:\Program Files\WebHelpDesk\pgsql3\pgAdmin4\bin

2. Double-click pgAdmin4.

3. Click Dashboard.

4. In the pgAdmin management tool window, click Add New Server.

5. In the Create - Server window toolbar, click General.

6. Enter whd to enable all whd users privileges to access the database.

   

   This enables all whd users privileges to access the database.

7. Click the Server group drop-down menu and select Server as the parent node for the server.

   

8. (Optional) Leave the Background and Foreground checkboxes selected to specify the background color for the server using the color-picker.

   

9. Ensure that the Connect now checkbox is selected to enable the client to connect to the server when you complete the database setup in pgAdmin4.

   

10. (Optional) Enter a comment regarding this database connection.

    

11. Click Connection in the toolbar.

12. Enter IP address or the fully qualified domain name (FQDN) of the server host.

    For example, localhost.

    

13. Enter the listener port number of the server host. The default value is 5432.

    

14. Enter the initial database name to which the client will connect. The default is postgres.

    

    If you are using pgAgent or adminpack objects, install these resources on the external database server.

15. Enter the role that will be used when authenticating with the server. The default is postgres.

    

16. Enter a password this role must enter to authenticate with the database server. .

    

    Record this password and keep it in a secure location. You will need this information in a future step

17. (Optional) Select the checkbox to save the password for future use. Leave this checkbox deselected for additional security.

    

18. Leave the Role and Service fields blank.

19. Click Save.

20. In the toolbar, click Connection.

21. Enter the IP address or the fully qualified domain name of the server host. For example, localhost.

    

22. Enter the listening port number of the server host. The default value is 5432.

    

23. Enter the name of the initial database to which the client will connect. The default value is postgres.

    

24. Enter the username that specifies the name of a role used when authenticating with the server. The default is postgres.

    

25. Enter a user password used to authenticate with the server.

    

26. (Optional) Select the checkbox to enable pgAdmin to save the password.

    

27. Leave the Role and Service fields blank.

28. In the Browser menu, expand Servers and click whd.

    

29. In the toolbar, click Privileges.

30. Select all options.

    

    After you select and save all options, the whd user can:

    • Log in to the database

    • Act as a superuser within the database

    • Create roles

    • Create databases

    • Inherit rights from the parent roles

    • Initiate streaming replication and backups

31. In the Browser navigation menu, expand whd and select webhelpdesk.

    

32. In the toolbar, click General.

33. Add a descriptive name for the database. For example, webhelpdesk. This name will display in the pgAdmin tree control.

    

34. Click the drop-down menu and select whd. This is the database owner.

    

35. (Optional) Enter comments about the database.

    

36. Click Save.

Complete the installation

1. Close pgAdmin4.

2. Return to the Select your Web Help Desk database window in the installation procedure.

   

3. Ensure that Use Custom SQL database (advanced) is selected.

4. Click the Database Type drop-down menu and select PostgreSQL (External).

   

5. In the Host field, enter localhost. In the Port field, enter 5432. This is the default port.

   

6. Enter the name of the Web Help Desk database. For example, webhelpdesk.

   

7. Enter the username.

   

8. Select the Create database and user account if necessary checkbox, enter the admin user name and password, and then click Create.

   

   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.

9. Click Next.

10. Go to Install WHD in a stand-alone deployment in the WHD Installation and Upgrade Guide.

11. Scroll down to Complete the installation.

12. Go to step 5 and continue the installation.

Back up the database

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

2. Create a directory for your database backup file.

   For example: 

   D:/Backup

3. On the Web Help Desk server, open a File Explore window and navigate to:

   C:\Program Files\WebHelpDesk\pgsql3\pgAdmin4\bin

4. Double-click pgAdmin4.

5. In the navigation pane, maximize Servers > whd > Databases.

   

6. Right-click webhelpdesk and select Back Up.

7. Enter a name for your backup file. You can also click the ellipsis, navigate to a directory, and select a file that will contain the archive.

   

8. Click the Format drop-down menu and select Custom. This option creates a custom archive file that you can use with pg_restore to create a copy of the database. This format allows you to select a database object to restore from the backup file.

   

9. Click the Encoding drop-down menu and select the character encoding method for the archive.

   

10. Under Dump options, accept all default settings.

11. Click Backup.

    When the backup is completed, a pop-up window displays:

    Successfully completed.

Restore the database

1. On the Web Help Desk server, open a File Explore window and navigate to:

   C:\Program Files\WebHelpDesk\pgsql3\pgAdmin4\bin

2. Double-click pgAdmin4.

3. In the navigation pane, maximize Servers > whd > Databases.

   

4. Right-click webhelpdesk and select Restore.

5. Click the Format drop-down menu and select the archive file format you selected in Back up the database. For example, select Custom or tar to restore from a custom archive file.

6. Double-click the Filename ellipsis and select your backup file.

7. Click Restore options and select all default selections.

8. Click Restore.

   When the restore is completed, a pop-up window displays:

   Successfully completed.