Skip to content

Install SPFx App

Gunjan Datta edited this page Oct 16, 2025 · 2 revisions

Required Files

Download the SPFx App package site-admin.sppkg file from the latest release.

Tenant vs Site Collection App Catalog

This solution is recommended to be in a single location in the tenant for everyone to use. We have two options for installing a solution for the tenant and a single site collection. If you install the app in the tenant app catalog, then it will be made available for anyone to install it within the tenant. To restrict this, you can install choose to install it to a site collection app catalog. Below will be the instructions for both options.

Option 1: Site Collection App Catalog (Recommended)

1. Create App Catalog

The first step is to create the app catalog in the site you want to install the solution to. I've provided both examples for completing this in PowerShell, based on your SharePoint PowerShell library preference. You can reference this link for Microsoft's documentation on configuring an app catalog.

SharePoint PowerShell Library
# Connect to the admin site
Connect-SPOService -Url https://tenant-admin.sharepoint.com

# Create the app catalog
Add-SPOSiteCollectionAppCatalog -Site https://tenant.sharepoint.com/sites/helpdesk
SharePoint PnP PowerShell
# Connect to the admin site
Connect-PnPOnline -Url https://tenant-admin.sharepoint.com -UseWebLogin

# Create the app catalog
Add-PnPSiteCollectionAppCatalog -Site https://tenant.sharepoint.com/sites/helpdesk
2. Upload SPFx Package

Access the site's app catalog we just created. Based on the above example, it would be https://tenant.sharepoint.com/sites/helpdesk/appcatalog. Click on the Upload button and select the site-admin.sppkg SPFx package file.

Upload App

3. Trust & Enable App

Once you upload the application, a window to enable it will be displayed. Since we are installing it to a single site collection, select the Make this solution available to all sites option and then the Deploy button.

Enable App

Option 2: Tenant App Catalog

1. Access App Catalog

From the SharePoint Admin Center, select More Features and then click on the Open button under the Apps feature.

Access App Catalog

2. Upload SPFx Package

Click on the Upload button and select the site-admin.sppkg SPFx package file.

Upload App

3. Enable App

We do not want to make the application available to all site collections, so we will select the option to Only enable this app, then click on the Enable app button to complete the request.

Enable App

4. Add App to Site

Access the target site's Site Contents page to install the solution on. Select New and then click on App.

App App to Site

5. Install App

Find the Site Admin tool app, and click on Add to install it to the site.

Install App

Clone this wiki locally