Skip to main content

Set up and run on-premise testing

  • Updated
Can’t find this feature? Contact your Customer Success Manager for more information.

The On-premise tool is an automated accessibility scanner that can access and scan environments that the platform may not be able to like intranets, development environments, or staging environments. 

The On-premise tool is available for download from the Tools & extensions page of the platform. Once set up, you can run the tool locally and push the scan results to the platform for review, prioritization, and remediation.

On this page:

Download the On-premise tool

To download the On-premise tool:

  1. Go to Tools & extensions.
  2. Find the On-premise tool.
  3. Select Download package. The download will begin automatically.
  4. In your downloads, unzip the On-premise testing tool.

Install the libraries

Note: you’ll need npm and node installed on your computer to set up the On-premise testing tool. If you don’t, contact your IT team.

Before you can use the On-premise tool, you need to install the libraries from the On-premise tool root folder and the vendor folder.

On-premise tool root folder

To install the libraries from the On-premise tool root folder:

  1. Open the On-premise tool root folder.
  2. Open the Terminal.
  3. Copy the On-premise tool root folder pathname.
  4. In the Terminal, enter cd and paste the root folder pathname. For example: 
    cd /Users/johnsmith/Downloads/onpremrootfolder
  5. Press enter.
  6. Enter: 
    npm install
  7. Press enter. The install will start.

Vendor folder

To install the libraries from the vendor folder:

  1. Open the vendor folder.
  2. Copy the vendor folder pathname.
  3. In the terminal, enter cd and paste the vendor folder pathname. For example: 
    cd ​​/Users/johnsmith/downloads/onpremrootfolder/vendor
  4. Press enter.
  5. Enter: 
    npm instal
  6. Press enter. The install will start.

Set up the on-premise configuration file

The on-premise configuration file tells the On-premise tool what pages to scan and where to push the results within the platform. Before running an on-premise scan, you’ll need to set up the on-premise configuration file.

Run a test scan

Once you’re all set up, run a test scan to make sure everything is configured correctly. The test performs a few browser actions against a publicly available website and runs an accessibility scan. If your configuration is set up correctly, the results will be pushed to the platform. 

To run a test scan:

  1. In the Terminal, enter:
    • Linux based systems: 
      • npm run test
    • Windows based systems: 
      • npm run test-windows
  2. Press enter. The test scan will start and begin sending results to the platform.

Run an on-premise test

Once you’ve installed and set up the On-premise tool and set up the eA configuration file, you can run an on-premise test. You can also find the steps to run an on-premise test in the On-premise tool README.md file.

To run an on-premise test:

  1. Open a new Terminal.
  2. Copy the On-premise tool root folder pathname.
  3. In the Terminal, enter cd and paste the root folder pathname. For example: 
    cd /Users/johnsmith/Downloads/onpremrootfolder
  4. Press enter.
  5. Enter: 
    npm run test:url-scanne
  6. Press enter. The scan will start and begin sending the results to the platform.

Related to

Related articles