Skip to main content

Installing Sprocket on Individual Sites

For larger organizations, specifically when their IT is managed internationally or by a third party, you may not be allowed to install Sprocket globally to all sites in the tenant.

There are two approaches to install Sprocket on individual sites only:

  1. Install to Tenant App Catalog without deploying to all sites (Recommended) - Upload to the tenant-wide App Catalog but don't enable automatic deployment, then manually add the app to specific sites.
  2. Install to Site Collection App Catalog - Create a site-specific App Catalog and upload Sprocket there.

This is the preferred method as it makes upgrading much more straightforward and provides centralized management while maintaining control over which sites have access to Sprocket.

Benefits​

  • Easier upgrades - update once in the tenant catalog
  • Centralized version management
  • Simple to add or remove from sites
  • No PowerShell required

Installation Steps​

  1. Follow the standard Installing Sprocket guide up to step 6.

  2. When you reach the "Enable app" pop-up in step 6, select the first option (not the second):

    • Do NOT check "Make this solution available to all sites in the organization"
    • Click Enable App

  3. Go to the API access page and approve all pending API permission requests (as described in the standard installation guide).

  4. Now Sprocket is available in your tenant App Catalog but not automatically deployed to any sites.

Adding Sprocket to Specific Sites​

To add Sprocket to a site:

  1. Navigate to the SharePoint site where you want to add Sprocket
  2. Go to Site Contents (usually via the Settings gear icon > Site contents)
  3. Click New > App
  4. Find and select Sprocket 365 from the available apps
  5. Click Add to install it on that site

Repeat these steps for each site where you want Sprocket available.

tip

This approach makes it easy to control access while maintaining a single source of truth for the Sprocket package. When you need to upgrade, simply upload the new version to the tenant App Catalog and all connected sites will receive the update.

Approach 2: Site Collection App Catalog​

This approach is useful when you don't have access to the tenant-wide App Catalog or need complete isolation for a specific site collection. However, it requires PowerShell and makes upgrades more complex as you'll need to update each site collection separately.

Overview​

Instead of using the tenant App Catalog, you can create a site-specific App Catalog and install Sprocket there. This catalog does not exist by default and requires PowerShell to create.

Step 1: PowerShell​

View detailed instructions here.

Run the following command:

Connect-SPOService -URL "https://contoso-admin.sharepoint.com" Add-SPOSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamSite"​​​​​​

Prerequisites​

In order to run the PowerShell, you must have the following roles:

  • SharePoint Admin role or Global Administrator role
  • Site Collection Administrator of the tenant App Catalog
  • Site Collection Administrator of the site collection of the site specified in the -Site parameter

Step 2: Install Sprocket​

Now that you have run the PowerShell and your App Catalog has been created, you can now install Sprocket.

You will find the App Catalog via one of the following ways:

  • In the Site Contents of the site collection (it will be called 'Apps for SharePoint')
  • Direct URL i.e. /sites/FinanceTeamsite/AppCatalog

Upload the sprocket-365.sppkg file to the local site collection app catalog and ensure you select 'Make this solution available to all sites in the organization' for Sprocket-365.

tip

Note: This needs to be done at each site collection you require Sprocket, not just the Hub site.