User documentation

Deployment

Written by Anjuli Juliana Weber | November 8, 2025

Version: 0.4

July 2025

Introduction

This manual provides step-by-step instructions for deploying and setting up the Layer2 ShArc system.

Layer2 ShArc is hosted entirely within your own Azure tenant and requires the following Azure resources:

  • Azure App Registration: Used for authentication.
  • Azure File Handler App Registration: Used by SharePoint to handle offloaded files.
  • Azure Storage Account: Serves as the storage for offloaded files.
  • Azure App Service and App Service Plan: Hosts the web application.

Setup Requirements

To deploy the ShArc system, the following files are required

Name Description Notes
Install-Sharc.ps1 Installation Script This PowerShell script installs all necessary components of the system, such as the App Registration, the File Handler, the Azure Storage Account and the App Service
ApiAccessManifest.json Permissions for App Registrations This JSON file contains the permissions for the App Registration and will be used by the installation script.
FileHandlerManifest.json Manifest for the File Handler This JSON file is a template which is used by the installation script to install the File Handler.
FileHandlerIcons.json Icons for the File Handler This JSON file is a template which contains the file icons for the File Handler. It is used by the installation script as well.
FileHandlerActions.json Actions for the File Handler This JSON file contains the actions that the File Handler can perform and how to do it. It is used by the installation script.
sharc-iac.json ARM template for Azure Resources This ARM template defines all the Azure resources that need to be deployed and configured for ShArc. It is being deployed by the installation script.
  • Global administrator access is required to create Azure App Services and grant permissions during the App registration process.

Installation

Executing the script

  1. Open an Azure Cloud Shell

    Note: If you are asked which shell you want to start, choose PowerShell

  2. Upload the files (Install-Sharc.ps1 and all the JSON files)

  3. Start the installation script

Script Modes

The deployment script provides several modes for installation. The default is install. It can be specified my adding -Mode <mode> when starting the script. The following modes are available.

Name Description
Install This is the default. Installs everything needed for ShArc, including App Registrations and Azure Resources.
Update Used for infrastructure updates. Adjusts and appends existing configurations and resources to meet new requirements or apply improvements.
UninstallAll Removes everything needed for ShArc, including App Registrations and Azure Resources.
EnsureAppRegistrations Makes sure the App Registrations exist, if they do, this does nothing, but if they do not exist, they will be created.
RemoveAppRegistrations Removes only the App Registrations and leaves all other resources unchanged. Important: without the App Registrations, ShArc will stop working.
UninstallKeepAppRegistrations Removes only the Azure Resources, but keeps the App Registrations for further use.

 

File Association

To aid users in handling offloaded files which are synchronized to the local file system through One Drive for Business, we created file associations for the .sharc extension. Details can be found here

Notes

Make sure that the Azure BLOB Storage permissions prohibit changes to the content as well to any BLOB metadata to make sure no manipulation is possible. Only the Global Administrator needs to have access to the BLOBs for ShArc to work properly.