Package Types

Depending on which version of Umbraco CMS you are using, we distinguish between two package types, NuGet packages, and Package ZIP files.

There are two main ways to install packages in Umbraco CMS: Package zip files and NuGet packages.

The zip file package type is only available for Umbraco version 8 and earlier versions. Learn more about it in the Package zip Files section of this article.

When developing a package you need to consider the Umbraco CMS version you're using before determining the package type.

  • Modern Umbraco (Umbraco 10+): Providing a NuGet package is the only option.

  • Legacy Umbraco (Umbraco 8 and earlier versions): It is recommended to provide both a zip file and a NuGet package.

NuGet Packages

A NuGet package is a standard way of delivering compiled code and configuration to a .NET project. NuGet packages contain dll-files and other files required for the solution. For more information on NuGet packages see Microsoft's An introduction to NuGet documentation.

NuGet packages can be installed using via the command line or through Visual Studio using either the Package Manager Console or the NuGet Package Manager.

See below, for an example of installing a package using the Package Manager Console in Visual Studio:

PM> Install-Package MyPackage -version 1.2

NuGet packages can include any solution files and can be configured to run PowerShell scripts after installation.

As NuGet packages are installed outside of the Umbraco website they cannot directly manipulate any of the Umbraco settings or content during their installation.

When adding or changing configuration of Umbraco as part of a NuGet package you need to develop code to run as part of a Migration. The Migration will run the first time the Umbraco site starts after the package is installed, applying the correct configuration.

Package zip files

Zip file packages are only available for Umbraco CMS 8 and earlier versions.

Refer to the NuGet Packages section above, if your website is using Umbraco 10 or a later version.

A package zip file can be installed directly through the Umbraco backoffice.

Packages zip files can contain:

  • Content

  • Solutions files (dlls, App_Plugins files, etc)

  • Document Types

  • Templates

  • Stylesheets

  • Languages

  • Dictionary Items

  • Data Types

  • Media

To include media in your package, select it in the "Media" section. Additionally, choose it in the "Package Files" section under "Path to file."

Last updated