Hosting extension from Office 365 CDN (Hello world part 4)
Note: The SharePoint Framework Extensions are currently in preview and are subject to change. SharePoint Framework Extensions are not currently supported for use in production environments.
In this article, you will learn how to deploy your SharePoint Framework Application Customizer to be hosted from an Office 365 CDN and how to deploy that to SharePoint for the end users. This article continues with the hello world extension built in the previous article # Deploy your extension to SharePoint (Hello world part 3) where we were still hosting the customizer from localhost.
Be sure you have completed the procedures in the following articles before you start:
- Build your first SharePoint Framework Extension (Hello world part 1)
- Connect your client-side web part to SharePoint (Hello world part 2)
- Deploy your extension to SharePoint (Hello world part 3)
Using the CDN in your Office 365 tenant
Office 365 CDN is the easiest way to host SharePoint Framework solutions directly from your tenant while still taking advantage of the Content Delivery Network (CDN) service for faster load times of your assets.
Enabling the CDN in your Office 365 tenant
Ensure that you have latest version of the SharePoint Online Management Shell by downloading it from the Microsoft Download site.
Connect to your SharePoint Online tenant through PowerShell:
Connect-SPOService -Url https://contoso-admin.sharepoint.com
Get the current status of public CDN settings from the tenant level by executing the following commands one-by-one.
Get-SPOTenantCdnEnabled -CdnType Public Get-SPOTenantCdnOrigins -CdnType Public Get-SPOTenantCdnPolicies -CdnType Public
Enable public CDN in the tenant
Set-SPOTenantCdnEnabled -CdnType Public
Now public CDN has been enabled in the tenant using the default file type configuration allowed. This means that the following file type extensions are supported: "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF".
Open up a browser and move to a site collection where you'd like to host your CDN library. This could be any site collection in your tenant. In this tutorial, we will create a specific library to act as your CDN library, but you can also use a specific folder in any existing document library as the CDN endpoint.
Create a new document library on your site collection called CDN and add a folder named helloworld to it.
Move back to the PowerShell console and add a new CDN origin. In this case, we are setting the origin as
*/cdn, which means that any relative folder with the name of cdn will act as a CDN origin.
Add-SPOTenantCdnOrigin -CdnType Public -OriginUrl */cdn
Execute the following command to get the list of CDN origins from your tenant
Get-SPOTenantCdnOrigins -CdnType Public
Notice that your newly added origin is listed as a valid CDN origin. Final configuration of the origin will take a while (approximately 15 minutes), so we can continue creating your test extension, which will be hosted from the origin once deployment is completed.
When origin is listed without the (configuration pending) text, it is ready to be used in your tenant. This is the indication of an on-going configuration between SharePoint Online and the CDN system.
Updating your solution project for the CDN URLs
Return to the previously created solution to perform the needed URL updates.
Update the write-manifests.json file (under the config folder) as follows to point to your CDN endpoint.
- You will need to use the publiccdn.sharepointonline.com as the prefix and then extend the URL with the actual path of your tenant
- Format of the CDN URL is as follows
https://publiccdn.sharepointonline.com/<tenant host name>/sites/site/library/folder
Save your changes.
Execute the following tasks to bundle your solution
- This will execute a release build of your project using the CDN URL specified in the write-manifests.json file. The output of this command will be located in the ./temp/deploy folder. These are the files which you will need to upload to the SharePoint folder acting as your CDN endpoint.
gulp bundle --ship
Execute the following task to package your solution
gulp package-solution --ship
This command will create an app-extension.sppkg package in the sharepoint/solution folder and also prepare the assets in the temp/deploy folder to be deployed to the CDN.
Upload or drag & drop the newly created client-side solution package to the app catalog in your tenant. Click the Deploy button.
Upload or drag & drop the files in the temp/deploy folder to the CDN/helloworld folder created earlier.
Congratulations, you have enabled a public CDN in your Office 365 tenant and taken advantage of it from your solution!