Skip to main content

Installing Sprocket

This article describes the process of installing Sprocket on your tenants.

info

YOU MUST DO THIS FIRST: Start a free trial from https://app.sprocket365.com/.

Once you create an account, follow the below steps to complete the installation. Installation files are available for download from the Website.

Prerequisites​

  • Start a free trial from https://app.sprocket365.com/.
  • Acquire tenant level permissions within Microsoft 365.
  • When prompted, approve the graph API permission request.
  • Once your tenant is provisioned to use Sprocket 365, download the following sppkg files:
    • Sprocket Library
    • Sprocket 365
tip

This article describes the installation of Sprocket to your entire Microsoft 365 tenant, so that Sprocket is available in all your sites. If you prefer, you can deploy the sppkg files to a single Site Collection App Catalog, so that Sprocket is available only in that site.

For more information, see Installing on individual Site.

Guided Installation Video​

Watch this video to get started or follow the steps on this article.

Installation Steps​

To install Sprocket 365, you must upload both the sppkg files into the SharePoint App Catalog.

Downloading Sprocket installation files​

Log into your Sprocket Dashboard using your work Microsoft credentials.

  1. Click the Sprocket Library link to download the sppkg file.

  2. Click the Sprocket 365 link to download the sppkg file.

    Sprocket Dashboard

Accessing SharePoint Admin Center​

  1. Log in to your SharePoint admin centre using Microsoft credentials.

    Your SharePoint Admin Center Home page is displayed.

  2. Click the Navigation Menu on the left and from options, select More features.

    The More features page, that displays the features from the classic SharePoint admin center, is displayed.

Opening the App Catalog​

  1. On the More features page, under Apps section, click Open:

    App Catalog

    The Manage apps page is displayed. This page is your document library that displays the apps available in your tenants. From here, you can upload, enable, and manage your apps.

Uploading Apps to the Tenant​

This section guides you through the process of uploading the previously-downloaded apps to the tenant, one after the other.

Uploading the Sprocket 365 App​

  1. On the Manage apps page, click Upload and locate the previously-downloaded sprocket-365.sppkg file:

    App Catalog

    tip

    Alternatively, you can drag and drop the sprocket-365.sppkg file into the document library.

  2. Select the sprocket-365.sppkg file from the downloaded location and click Open.

    The Sprocket 365 app is uploaded and the Enable app pop-up is displayed.

  3. On the pop-up, click Enable App to enable the Sprocket 365 app that you are uploading:

    App Catalog

    The Approve Access pop-up is displayed.

  4. Click the I'll do it later option.

Uploading the Sprocket Library App​

  1. On the Manage apps page, click Upload and locate the already downloaded sprocket-library.sppkg file:

    App Catalog

    tip

    Alternatively, you can drag and drop the sprocket-library.sppkg file into the document library.

  2. Select the sprocket-library.sppkg file from the downloaded location and click Open.

    The Sprocket Library app is uploaded and the Enable app pop-up is displayed.

  3. On the pop-up, under App availability, select the Enable this app and add it to all sites option to enable the app that you are uploading.

    App Catalog

  4. On the pop-up, click Enable App. The Approve access so this app works as designed pop-up is displayed.

  5. On the pop-up, click Goto API access page option to approve the API access permission. The API access page is displayed in a new browser tab.

    On this page, the API name column displays Pending requests under the Organization-wide section.

Approving the Uploaded Packages in the Apps​

  1. Select a package and on the top, click Approve.

    App Catalog

    The Approve access pop-up is displayed.

  2. On the pop-up, click Approve.

  3. Repeat the steps for all the pending requests.

Once completed, all the approved packages are displayed in the API name column under Approved requests in the Organization-wide section.

Congratulations!, you have now installed Sprocket. Once installed you can see your Sprocket web parts when editing a SharePoint page. You will also see the Sprocket Settings icon in the bottom left corner of every page.

note

After the installation, it may take up to 10 minutes to see the Sprocket icon on your SharePoint site, due to SharePoint's caching techniques.