Important Prerequisites

• A computer/server with:
  • a 64-bit Microsoft Windows operating system (view supported Windows versions)
  • Microsoft .NET Framework 4.6 or newer

  • PerformanceGuard 7.5 and newer uses OpenJDK included in the installation file 

    Note
    icon false
    For PerformanceGuard versions 7.4 or older you must install Java JDK 8 update 181 or later(see Install Java JDK)

• Administrative rights on the computer that you are going to perform the installation on (local administrator).

• A Microsoft SQL Server (MS SQL Server 2012 or newer, either on the same computer as PerformanceGuard or on a dedicated server). 

  Info
  icon false
  Expand title Can I use SQL Server Express? SQL Server Express is only suitable for very small PerformanceGuard installations (less than 100 users) because SQL Server Express has an upper limit on its database size.

  PerformanceGuard doesn't itself use SQL Server Enterprise features, but you may use them in case you want to exploit more memory on large installations.

• During installation you'll get the option of authenticating service access to the PerformanceGuard databases through the Windows credentials of one or more existing Active Directory users. If you intend to use that option, make sure that the relevant user accounts have been set up in Active Directory.
• During installation you'll specify the user accounts that will run the various components of PerformanceGuard. If you are going to use Windows authentication (see the previous item), it is important that the user accounts have:
  • Full access to the folder in which you'll install the component in question
  • Full access to the Windows registry on the computer in question
• Download the PerformanceGuard installer. Download the PerformanceGuard installer from CapaSystems wiki.

A New Installation

Step 1: Run the installer PerformanceGuardServer.exe

Follow the wizard

Step 2: Accept the End-User License Agreement

Step 3: Select the components to install

Select the component you want to install:

• Backend
  • Contains the backend data aggregation service and the Display services (The GUI)
• Frontend:
  • Contain the frontend service that agents connect to

Then select the location at which you want to install PerformanceGuard.  (Defaullt path is Program Files)

Step 4: Create Backend Database

• Server: Which server should run the Backend server database? If the SQL Server that you want to use exists on the computer that you are installing the Backend server on, simply use the localhost default setting. If you have another SQL Server on your network, and you want to install the Backend server's database on that server, click the browse button next to the field and select the required SQL Server. 

  Tip
  icon false
  If your SQL server uses another port than the default port 1433, you can add the port number after the server address. Example: localhost:6789 If you want to use a particular instance on your SQL Server, you can add the instance name after the server address, separated by a backslash. You can also combine instance and port information if required. Examples: localhost\instance or localhost\instance:6789

• Database Name: The name of the Backend server database. The name is normally pguard, but you can change that if required.
• Use Windows Account enable if you want to use a Windows Active Directory User
• Windows domain (only relevant if you selected Windows Account): Specify the domain that the Active Directory user belongs to.
• Username: In order to communicate with the Backend database, PerformanceGuard needs access to the database with a user account.
  • If using SQL Server authentication the name of that user account is normally pguard, but you can change the name if required.
  • If you use Windows authentication, you must specify the user name of an existing Active Directory user.
• Password: Specify the password that PerformanceGuard should use when it accesses the Backend server database with the user account that you specified previously.

  • If you use SQL Server authentication, the password must follow the password policy for the SQL Server that you use. 

  • If using Windows authentication specify the password of the Active Directory user.

    Tip
    icon false
    View Microsoft's SQL Server password policies (link applies for SQL Server 2012, but you can select other SQL Server versions on the page).

Step 5: Backend SQL Server

Determines whether you want to let the PerformanceGuard installer create the Backend server database for you automatically (recommended). If you select this option, you must provide system administrator credentials for the selected SQL Server in the following fields.

This must be a different user than the backend database user that you specified previously.

• If using SQL Server authentication the name of that account is normally sa, but you can change the name if required.
• If using Windows authentication you must specify the user name of an existing Active Directory user that has system administrator rights on the SQL Server.

• Use Windows Account enable if you want to use a Windows Active Directory User
• Windows domain (only relevant if you selected Windows Account): Specify the domain that the Active Directory user belongs to.
• SA Username: Specify the user name of the SQL Server's system administrator account..
• SA Password: Specify the password of the SQL Server's system administrator account.

Use the Test Connection button to verify that the connection to the database works. 

• DB Data Files Directory Path to store the new Data Files
• DB Log Files Directory Path to store the new Log Files

By default, Backend server database files will be placed at the SQL Server's default location for new databases (<Server default>). That's usually fine, but occasionally it may not be the best choice, for example if you expect to collect a lot of data, but there isn't much available disk space at the default location. That's why you are able to specify your own paths for data files as well as log files.

Step 6: Backend Properties

• Backend Server Port: On which TCP port should the Backend server deliver data? We recommend that you use port 4008 unless your organization's firewall administrator has told you to use another port.

• Primary Display Port and Secondary Display Port: PerformanceGuard has a web server service that runs the PerformanceGuard web interface. The web server needs to use two TCP ports. Make sure that no other applications use those ports. 

  Tip
  icon false
  When you move on, the installer automatically checks the availability of the ports that you specify. If you run into problems with port 80, see the troubleshooting article Port 80 Is Used by Another Service.

• Use SSL: enable HTTPS. Change the port numbers to 443 and 8443 and add the Certificate File Path, The path to the certificate file on the local machine and the Certificate Password.

Step 7: Create Frontend Database

Back up your PerformanceGuard Frontend and Backend server databases before you upgrade your PerformanceGuard installation. Having a backup is important in the unlikely case that something goes wrong during your upgrade.

Step 8: Frontend SQL Server

Back up your PerformanceGuard Frontend and Backend server databases before you upgrade your PerformanceGuard installation. Having a backup is important in the unlikely case that something goes wrong during your upgrade.

Step 9: Frontend Properties

Back up your PerformanceGuard Frontend and Backend server databases before you upgrade your PerformanceGuard installation. Having a backup is important in the unlikely case that something goes wrong during your upgrade.

Step 10: Install

Back up your PerformanceGuard Frontend and Backend server databases before you upgrade your PerformanceGuard installation. Having a backup is important in the unlikely case that something goes wrong during your upgrade.