Configure Microsoft SQL Server
To configure SQL Server for your Web Help Desk deployment, use the SQL Server Configuration Manager to enable TCP/IP on SQL Server. When completed, use SQL Server Management Studio to create and configure SQL Server to the Web Help Desk database instance.
Enable TCP/IP in SQL Server
Configure the following settings in the SQL Server Configuration Manager.
Setting | Value |
---|---|
TCP/IP Protocol | Enabled in SQL Server Network Configuration > Protocols for SQL 20xx |
IP Address |
127.0.0.1 (if installed on the WHD server) Server IP address (if installed on a separate server) |
TCP Port | 1433 |
IPAll | |
TCP Dynamic Ports | Blank |
TCP Port | 1433 |
Create and configure your SQL Server database
Configure the following settings in the SQL Server Management Studio for SQL Server to create and configure SQL Server to the Web Help Desk database instance.
Setting | Value |
---|---|
SQL Server Authentication | Enabled |
Login Name | whd |
SQL Server Authentication: Password |
Enabled and configured |
SQL Server Authentication: Enforce password policy |
Disabled |
SQL Server Authentication: Enforce password expiration |
Disabled |
SQL Server Authentication: User must change password at next login |
Disabled |
Database name | whd |
Database owner | whd |
(Optional) Enable SSL encryption
Perform the following steps to set up SSL encryption for a supported SQL Server database connected to Web Help Desk.
Set up the SSL connection
-
Follow the steps in Encrypting Connections to SQL Server on the Microsoft Docs website to set up the SSL connection on the SQL Server database.
When the ForceEncryption option for the database engine is set to Yes, all client/server communications are encrypted. This option denies access to clients that cannot support encryption.
- Start the database server with SSL enabled.
Enable SSL encryption for a new WHD installation
If you are upgrading WHD or installing the software for the first time, perform the following steps:
- Download and run the WHD installer.
- Follow the steps in the Getting Started Wizard.
- In the Select your WHD database window, add the database information.
- Select Use custom SQL Server database (advanced).
-
In the Database Name field, enter:
whd?ssl=true
-
Complete the wizard.
SSL is enabled.
Enable SSL encryption for an existing WHD installation
If you are configuring SSL encryption for an existing WHD installation, perform the following steps:
- Stop WHD.
-
Navigate to the extensions directory based on your operating system.
Microsoft Windows:
\Program Files\WebHelpDesk\bin\jre\lib\ext
macOS:
/Library/Java/Extensions
Linux:
/usr/local/webhelpdesk/bin/jre/lib/ext
- Open the
conf
directory. - Open the
.whd.properties
file in a text editor. - Edit the following properties:
whd.db.port=1433
whd.db.sid=
whd.db.customUrl=
whd.db.subprotocol=microsoft
whd.db.password={DES}B/cdbZvGZws\=
whd.db.host=<server_name>
whd.db.useCustomUrl=NO
whd.db.name=whd:encrypt=true #
whd.db.username=whd
whd.db.embedded=NO
-
Open the WHD home directory.
- macOS:
/Library/WebHelpDesk
- Microsoft Windows:
\Program Files\WebHelpDesk
- Red Hat/CentOS/Fedora Linux:
/usr/local/webhelpdesk
- macOS:
-
Locate the Portecle application at:
<WebHelpDesk>/bin/Portecle.jar
-
Using Portecle, import the certificates to the following location:
<WebHelpDesk>/bin/jre/lib/security/cacerts/<webhelpdesk_home>
- Start WHD.
If you are unable to connect to the SQL Server database, ensure that:
- The appropriate certificate was imported into the
cacerts
directory. - The path to the WHD home directory is correct.
If you still cannot connect to the SQL Server database, collect the log files and contact Technical Support.