PingFederate Server

Installing PingFederate on Windows

Before you begin

  • Request a license key through the Ping Identity licensing page.

  • Ensure you are signed on to your Windows system with sufficient privileges to install and run an application. PingFederate needs read, write, and execute permissions to function.

  • Verify that you have installed the Java Runtime Environment (JRE) and that you have set the required environment variables correctly. Learn more in Installing Java.

About this task

You can install PingFederate on a Windows system using the installer for Windows or the distribution .zip archive. Using the installer for Windows is the preferred method.

To configure PingFederate to run as a service on Windows, install PingFederate on Windows manually. Learn more in Installing the PingFederate service on Windows manually.

To install PingFederate:

Steps

  1. Install PingFederate using the installer for Windows or the distribution .zip archive:

    Choose from:

    • To install using the PingFederate installer for Windows:

      1. Download the PingFederate installer for Windows from the Ping Identity website.

      2. Double-click the .msi file to open the PingFederate Setup Wizard, and follow the instructions to complete the installation.

        PingFederate is configured to run as a service and starts automatically at the end of the installation process.

        The PingFederate installer for Windows installs only one instance of PingFederate on a Windows server. If you need additional PingFederate instances on the same Windows server, install them using the distribution .zip archive.

        You must manually configure various port settings in the <pf_install>/pingfederate/bin/run.properties file for each instance to avoid port conflicts.

    • To install PingFederate using the distribution .zip archive:

      1. Download the distribution .zip archive from the Ping Identity website. The distribution .zip archive is identical for both Windows and Linux.

      2. Extract the file into an installation directory.

  2. If you have installed PingFederate by extracting the distribution .zip archive, start PingFederate manually by running <pf_install>/pingfederate/bin/run.bat.

    Wait for the script to finish. The startup process completes when you see the following message.

    {pingfed}  running...

    When running PingFederate for Windows, switching the Java version from 11 to 17 prevents the service from running, and you won’t be able to start PingFederate. The problem occurs because garbage collection logging configuration arguments that are used by Java 17 are incompatible with those used by Java 11.

    To change Java versions:

    1. Run <pf_install>\pingfederate\sbin\win-x86-64\uninstall-service.bat to de-register the PingFederate service.

    2. Install the new Java version and update the JAVA_HOME and PATH environment variables.

    3. Run <pf_install>\pingfederate\sbin\win-x86-64\install-service.bat to register the PingFederate service.

Next steps

If your organization plans to manage keys and certificates using a hardware security module (HSM), see Supported hardware security modules.