---
title: Installing PingFederate on Windows
description: Generate a license key.
component: pingfederate
version: 13.1
page_id: pingfederate:installing_and_uninstalling_pingfederate:pf_install_pf_on_windows
canonical_url: https://docs.pingidentity.com/pingfederate/13.1/installing_and_uninstalling_pingfederate/pf_install_pf_on_windows.html
llms_txt: https://docs.pingidentity.com/pingfederate/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: February 2, 2023
section_ids:
  before-you-begin: Before you begin
  about-this-task: About this task
  steps: Steps
  choose-from: Choose from:
  next-steps: Next steps
  related-links: Related links
---

# Installing PingFederate on Windows

## Before you begin

* [Generate a license key](https://docs.pingidentity.com/pingfederate/latest/administrators_reference_guide/pf_generate_new_license_key.html).

* 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](pf_install_java.html).

## 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](pf_install_pf_service_on_windows_manually.html). |

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](https://www.pingidentity.com/en/resources/downloads/pingfederate.html).

     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](https://www.pingidentity.com/en/resources/downloads/pingfederate.html). 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.

   ```json
   PingFederate running...
   ```

   |   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
   | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   |   | When running PingFederate for Windows, switching the Java version from 11 to 17, or 11 to 21, 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 and 21 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](../getting_started_with_pingfederate/pf_supported_hardware_security_modules.html).

## Related links

* [memoryoptions and installation](../performance_tuning_guide/pf_memoryoptions_install.html)

* [Fine-tuning JVM options](../performance_tuning_guide/pf_fine_tuning_jvm_option.html)