Skip to content

Getting Started

Jump to bottom
GitHub Action edited this page May 18, 2026 · 4 revisions

Getting Started

Prerequisites

  • PowerShell 5.0 or later
  • PowerShell 7.x (optional, recommended for warm-up worker script)
  • Administrative privileges on the SharePoint Server
  • Install and run the script on SharePoint Web Front End (WFE) servers
  • Do not install or run the script on servers with the Search MinRole

Installation

Download the latest release

Download the release from Github and unzip to a directory on your SharePoint Server.

Ensure these files are present in the same folder:

  • SPSWakeUP.ps1
  • SPSWakeUp-pwsh.ps1

Download the release from PSGallery Alternatively, you can install the script directly from the PowerShell Gallery by running:

Install-Script -Name SPSWakeUP -Verbose
Install-Script -Name SPSWakeUp-pwsh -Verbose

SPSWakeUP.ps1 remains the main entrypoint. If pwsh is available, it delegates warm-up requests to SPSWakeUp-pwsh.ps1; otherwise it uses a PowerShell 5.1 fallback flow.

Install the script in TaskScheduler

Run this install action from a WFE server only (not from a Search MinRole server).

Run the script with the following command:

.\SPSWakeUp.ps1 -Action Install -InstallAccount (Get-Credential)

Next Step

For the next steps, go to the Usage page.

Change log

A full list of changes in each version can be found in the change log.

Clone this wiki locally