Headless Browser setup for Microsoft Windows

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Headless Browser setup for Microsoft Windows

    The ServiceNow® Headless Browser for Automated Test Framework (ATF) allows for automated testing without manual browser intervention. This setup guide focuses on the installation process for Microsoft Windows, emphasizing that it is a legacy feature, with recommendations to use the ATF Test Generator and Cloud Runner for those on Cloud instances.

    Show full answer Show less

    Prerequisites

    • Multi-Factor Authentication (MFA) must be disabled in your instance.
    • Required roles: Admin on the ServiceNow instance and local administrator on the host machine.
    • Supported operating system: Windows Server 2019 v10.0.17763.737. Other versions are not supported; a Linux host is recommended if requirements are not met.
    • Necessary software installations: Docker, Java keytool, and OpenSSL via Chocolatey.
    • Ensure two-way communication between the instance URL and the server, with appropriate firewall settings.

    Steps to Set Up the Headless Browser for Windows

    Follow these steps for the one-time setup:

    1. Install Docker on your Windows server.
    2. Generate TLS/SSL certificates to secure the Docker REST API.
    3. Configure Docker to authenticate all requests.
    4. Pull the Docker image from the Public Registry.
    5. Create a Docker secret for the ServiceNow user’s password.
    6. Set up your instance to support the Headless Browser.
    7. Configure ATF with the necessary properties.
    8. Verify the setup procedures to ensure successful implementation.

    Key Outcomes

    By completing this setup, ServiceNow customers will enable automated testing through the Headless Browser on Windows, streamlining their testing processes. However, for enhanced functionality and ease of use, transitioning to Cloud Runner is recommended for those eligible.

    The ServiceNow® Headless Browser for Automated Test Framework (ATF) provides automation so you can skip having to manually open a browser during testing. The Headless Browser setup is available in both Linux and Microsoft Windows. This topic covers the setup for Windows.

    Important:
    Headless Browser is a legacy feature of ATF; it is recommended to instead use the ATF Test Generator and Cloud Runner application. Cloud Runner offers you an easy setup and a seamless user experience. You can install Cloud Runner from the store app.
    If you are an on-premise instance user, you must continue using the Headless Browser option. Cloud Runner is not currently available for on-premise instances.

    There are several sequential procedures to follow in the one-time setup. Below are the instructions for the Microsoft Windows setup.

    Prerequisites

    Note:
    MFA must be disabled in your instance to use the Headless Browser option.
    Role required: admin on your ServiceNow instance and local administrator on the host machine.
    Warning:
    The only supported version of Microsoft Windows as a host is Windows Server 2019 v10.0.17763.737. No other versions are supported. If you are unable to meet these requirements, a Linux host is recommended.
    • Make sure that the following programs are installed on your Windows server:
    • Two-way communication
      • There must be two-way communication between the instance URL and your server.
      • Find the IP address of your server and get your hostname. You can use one or both of them, but you need at least one. Make sure the address or hostname are visible from your ServiceNow instance.
      • See My IP Address to find the IP address ranges of your instance. You can then configure your server to allow inbound access to all of the indicated IP addresses/ranges.
      • Use Port 2376 or your own default port for this procedure. Make sure your server's firewall rules allow inbound requests on this port from the IP addresses you get from the instance.
      Note:
      If you don't have a hostname and are connecting via the IP address, you can enter the IP address and put "localhost" in the Hostname environment variable.
    • To learn more, see Use TLS (HTTPS) to protect the Docker daemon socket.

    Steps to set up the Headless Browser for Windows

    Follow these seven steps (plus verification) to set up the Headless Browser for Windows.