Installing and Uninstalling Packages
The process of installing and, in turn, uninstalling packages in your Umbraco CMS website depends on the version and package type.
This article will cover the process of installing as well as uninstalling packages from your Umbraco CMS website.
As the article will cover both NuGet packages and zip file packages, it is important to know the distinction:
- NuGet packages: Modern Umbraco (Umbraco 10+) and Legacy Umbraco (Umbraco 8 and earlier versions).
- Package zip files: Legacy Umbraco (Umbraco 8 and earlier versions) only.
In the Umbraco Backoffice, you will find a Packages section that displays the Umbraco Marketplace. From here you can browse all community-made as well as official Umbraco packages for the Umbraco CMS.
Backoffice - Packages section
For Umbraco CMS version 8 and earlier versions, the Packages section displays the Packages site on Our.
NuGet package
Package zip file
Navigating to a specific package in the section will present you with an overview of the package, as well as an install snippet for NuGet CLI.
Backoffice - Starter Kit package
The packages can be installed by using:
- NuGet Package Manager in Visual Studio
- Package Manager Console in Visual Studio
- .NET CLI (usually accessible from the terminal/command prompt of your system)
For example, to install the StarterKit package for the Umbraco CMS the command would be:
dotnet add package Umbraco.TheStarterKitNavigating to the NuGet Package Manager in Visual Studio is more visual, and gives you an overview of already installed packages.
Visual Studio - nuget packages manager
The Package Manager has an integrated search function that allows you to find any public NuGet package and install it on the project.
Visual Studio - finding The Starter Kit
Once the package has been installed, it will show up under the Packages section in the backoffice, under Installed tab.
Backoffice - installed packages
Package zip files are only available for Umbraco 8 or earlier versions.
Once you have downloaded an Umbraco package zip file, you can install it in the Umbraco backoffice by following the steps below:
- Navigate to the Packages section.
- Select Install local on the top-right side of the page.
- Drag'n drop the package onto the page or use the file explorer to select the package zip file.
- Accept terms of use to confirm the package installation.
The package will be installed and any necessary reboots of the site will be initiated.
You can also install packages directly when browsing the packages in the Umbraco backoffice. This is usually preferred in order to ensure that the package is compatible with the Umbraco CMS version used.
- Navigate to the specific package you want to install.
- Click Install package in the right-hand side of the page.
- Confirm the installation.
The package will be install and the site will be rebooted.
Uninstalling packages is not always as straightforward as installing them.
In this section, we will provide two examples of uninstalling a package - the StarterKit package and the SEOChecker package.
Keep in mind that this particular guide targets a specific package. There are many packages out there, and each one is different. The exact steps presented here might not work the exact same way for all the packages, though the general approach should still apply.
The Starter Kit provides you with a boilerplate website solution to build upon. The package installs Document Types, Templates, media, content, and everything else needed to set up a small website. There is little custom code/functionality involved which is usually the case for such starter kit or sample-site packages.
To uninstall a package, either run a command or use the NuGet Package Manager in Visual Studio.
dotnet remove package Umbraco.TheStarterKit
Visual Studio - uninstalling via Package Manager
If you are using Umbraco 8 or an earlier version you uninstall the packages directly from the Packages section of the Umbraco backoffice.
- 1.Navigate to the Installed tab in the Packages section.
- 2.Click Uninstall package next to the package you want to uninstall.
- 3.Confirm that action by checking Confirm package uninstall.
It is recommended to clean the solution after removing any package. This can be done by right-clicking the project in Visual Studio and choosing the Clean option, or using the
dotnet clean command.
Visual Studio - clean solution
With packages like the StarterKit, the process does not end there. While the package is gone, content - and everything else needed for the website - is still available in the backoffice. To fully remove this kind of package, additional steps are needed.
There is no universal way to tell what content comes from a package, and what content is custom-made. In the Content section, delete individual nodes accordingly. If the goal is to fully remove the package and clean the site, all the content can be removed (and the recycle bin emptied).
As opposed to Document Types, there are some Data Types that are available out of the box when Umbraco is installed. It is not recommended to remove them. The safe approach is to delete any item that starts with a Document Type prefix and includes multiple dashes. That is the default naming convention for new configurations of Data Types (Example: "Blog - How many posts should be shown - Slider")
Some packages might reference other items. For example, installing the StarterKit also adds
Bergmania.OpenStreetMap to your project. That component will show up as installed in the backoffice even after uninstalling the NuGet package.
In many cases, custom dashboards, editors, and scripts are left in the
App_Plugins folder after a package has been uninstalled via NuGet. These files also have to be deleted manually.
Keep in mind that this particular guide targets a specific package. There are many packages out there, and each one is different. The exact steps presented here might not work the exact same way for all the packages, though the general approach should still apply.
More advanced packages that add functionality on top of Umbraco, usually rely on providing custom, compiled code. That being said, many of such packages also implement custom Sections, Dashboards, editors, and views.
In this example, we will be using the SEOChecker package. This package allows developers of the site to add custom properties to Document Types used to track search engine optimization practices.
An example use case of the SEOChecker property on a Document Type, as presented in the Content section:
SEOChecker in content
To uninstall the SEOChecker from a website, the first step is to remove the package via a
dotnet command or use the NuGet Package Manager.The following command can be used for uninstalling the package:
dotnet remove package SEOCheckerAfter that, cleaning the solution is recommended.
Visual Studio - clean solution
If content on the website relies on having a custom Property Editor or a data source installed, those properties will default to a
label Data Type. All previously saved content in the property will in turn be converted to a string.In the case of the SEOChecker, the custom property added from the package would look like this after all the package files have been removed:
The SEOChecker in Content after removing the package
Depending on the packages and the implementation, rendering of content from custom editors, or any frontend functionality dependent on external code, might not work correctly. It is always recommended to inspect the frontend of the site after removing any packages.
Last modified 13d ago