SpHUB Book a demo

Install SPHub in your SharePoint tenant

Installing SPHub involves three administrator tasks: upload one SPHub.sppkg file to your tenant App Catalog, approve three Microsoft Graph permissions, and run the setup wizard on a site. It is an intranet setup with no custom development, and this page is the checklist to keep open while you do it.

These steps describe the Marketplace add-in, the single .sppkg package with its setup wizard. The free add-in and SPHub (SaaS) are separate Marketplace listings, and how the SaaS listing is installed is not published yet, so this page does not say it follows the same steps.

Before you start: prerequisites

Installing SPHub needs a Microsoft 365 tenant with SharePoint Online, a tenant App Catalog, a SharePoint administrator to approve API access, the site you want it on, and a decision about which modules to enable.

  • A Microsoft 365 tenant with SharePoint Online

    SPHub runs on SharePoint Online modern pages. No custom script has to be enabled.

  • Access to the tenant App Catalog

    The package is deployed tenant-wide, from the App Catalog you already manage.

  • A SharePoint administrator

    A SharePoint administrator approves the three Graph permissions in the SharePoint admin center, under API access.

  • A site, and a Site Owner to run setup on it

    Setup is run on a site, and it creates the home page, module pages and menu there. It needs the SharePoint Manage Web (Full Control) permission or Site Collection Administrator, which covers Site Owners and Site Collection Administrators. Members (Edit) and Visitors are never shown setup. Choosing a development site first is a reasonable way to see what it builds.

  • A decision on which modules to enable

    See the last section of this page. Modules can be added after setup but not removed through the wizard, so it is the one choice that is easier to make before you run setup than after.

  • The package file

    The add-in is listed as free on Microsoft Marketplace (see pricing). How SPHub.sppkg is obtained after you acquire the add-in is not published yet. The demo is the quickest way to get that answered against a real tenant.

The three steps, in order

Installing SPHub takes three steps: upload SPHub.sppkg to the App Catalog, approve three Graph permissions, and run setup on a site.

  • 1. Upload SPHub.sppkg to the tenant App Catalog

    Add the file to the App Catalog and deploy it tenant-wide. The package sets skipFeatureDeployment, so no site has to be activated by hand. Setup itself is still run per site, and it creates its lists in the site you run it on.

  • 2. Approve three Graph permissions

    In the SharePoint admin center, open API access and approve Mail.Send, User.Read and People.Read. Those three are everything SPHub asks for. What each one is used for is written out on the security page.

  • 3. Run setup on your site

    Open the site as a Site Owner or Site Collection Administrator. There is no page to find and no button to look for: the installer is a SharePoint application customizer, so it runs on the site by itself. If nothing is installed yet, the setup launcher opens on its own; choose your modules there. The next section lists what it builds.

What the setup wizard creates

The wizard creates lists and fields for the modules you enable, builds the home page and the module pages, and creates the site menu.

A full install

count
  • SharePoint lists24
  • Custom fields153
  • Graph permissions approved3
  • Web parts available27

The 24 lists and 153 fields are the figure for a full install, with every module enabled. Lists are created only for the modules you enable.

  • Lists, fields and a default view

    The wizard creates SharePoint lists for the modules you enable, each with its fields and a default view. They are ordinary lists you can open, export and audit.

  • Pages and a menu

    The wizard builds a home page and a page for each module, then creates the site menu that links them.

Running setup again is safe

Running setup again repairs the site rather than only skipping what exists: it compares what the blueprints describe with what is on the site, and fixes the differences it finds.

  • What a re-run fixes

    A list that does not exist is created. A list that exists but is missing fields gets those fields added. Fields that should be indexed but are not are indexed. Required columns missing from a list's default view are appended to it, without removing or reordering what is already there. An empty list that should have starter items gets them.

  • What a re-run does not overwrite

    A default value that differs from the blueprint is left alone, because a customer may have changed it on purpose. That difference is reported rather than repaired.

  • Re-running after a problem

    An interrupted run is recoverable. Run setup again and it completes what is missing, without creating a second copy of a list.

  • Enabling a module later

    A module that is already installed is shown as installed and cannot be unchecked in the wizard, and modules marked required are always checked. You can add modules you did not enable before. Adding later is supported; removing through the wizard is not.

  • How the wizard decides to open

    The installer opens itself only when there is something to do. If nothing is installed, the setup launcher opens. If a newer package is deployed than the version the site has recorded, it opens in upgrade mode. If the site is up to date, nothing opens, and a floating action button is there if an admin wants to open it. The recorded version lives in the site's own SPHubInstallerSettings list, on the server rather than in browser storage, so every admin of the site sees the same state and a second browser never re-triggers a setup that is already done.

  • Upgrades

    To upgrade, deploy the newer package to the App Catalog. The next time an admin visits the site, the installer sees that the site's recorded version is behind and opens in upgrade mode. There is no separate upgrade tool.

Decide before you run it: which modules

Lists are created only for the modules you enable, so the choice of modules decides how many lists and fields appear in your tenant.

  • Communicate

    Corporate announcements, events, content carousel, video gallery, FAQ and the company directory.

  • HR and people

    Annual leave, expenses, recruitment, travel requests, new-employee onboarding, birthdays and daily lunch menus.

  • Assets and operations

    Asset management, contract management, procurement, issue tracking, vehicle assignment and shuttle routes.

  • Navigation

    Quick links, icon links, department links and recent documents.

The web parts page describes each module, which helps when you are choosing. Two more things are worth settling beforehand: who will be the named contact person for email-enabled modules, because nothing is sent until one is configured, and which brand colour the site should use.

Prefer to see it running first

Book a demo and see the product running in a tenant, or go straight to the Marketplace listing.

Book a demo Microsoft Marketplace