-
Notifications
You must be signed in to change notification settings - Fork 803
Adds some general information about considerations for upgrades #7288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
23c3c18
7cb8de7
7ea0de0
3500e1d
d63d10c
8d4e68d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we use "obselete" more than we use "legacy". Perhaps rewrite to: They are only removed in major versions and with plenty of notice under announcements on the Umbraco repository on GitHub. When a feature is deprecated, a minor version is released with the deprecation, and the feature is deprecated for the next major release. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Have rewritten this slightly - mainly to add reference to the announcements repository, which is good to call out I agree. On the wording though, I think legacy is right here when we talk about features, and it's the word we used when retiring "Nested Content" for example. Obsolete is more used for code APIs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All good, if "legacy" is the right wording. I just noticed we use "deprecation" on this page https://umbraco.com/products/knowledge-center/versioning-and-release-cadence/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,210 +1,11 @@ | ||
--- | ||
description: This is the guide for upgrading existing installations in general. | ||
description: This is the guide for upgrading existing Umbraco installations. | ||
--- | ||
|
||
# Upgrade your project | ||
|
||
In this article, you will find everything you need to upgrade your Umbraco CMS project. | ||
In this section, you will find everything you need to upgrade your Umbraco CMS project. | ||
|
||
You will find instructions on how to upgrade to a new minor or major version as well as how to run upgrades unattended. | ||
If you are new to upgrades, see our introduction to [upgrades in Umbraco](./upgrade-introduction.md). This will give you an understanding of what goes on and the different topics you need to consider. | ||
|
||
* [Before you upgrade](./#before-you-upgrade) | ||
* [Upgrade to a new Major](./#upgrade-to-a-new-major) | ||
* [Upgrade to a new Minor](./#upgrade-to-a-new-minor) | ||
* [Run an unattended upgrade](./#run-an-unattended-upgrade) | ||
|
||
## Before you upgrade | ||
|
||
The following lists a few things to be aware of before initiating an upgrade of your Umbraco CMS project. | ||
|
||
* Sometimes, there are exceptions to general upgrade guidelines. These are listed in the [**version-specific guide**](version-specific/). Be sure to read this article before moving on. | ||
* Ensure your setup meets the [requirements](../requirements.md) for the new versions you will be upgrading your project to. | ||
* Things may go wrong for different reasons. Be sure to **always** keep a backup of both your site's files and the database. This way, you can always return to a version that you know works. | ||
* Before upgrading to a new major version, check if the packages you're using are compatible with the version you're upgrading to. On the package's download page, in the **Project compatibility** area, click **View details** to check version-specific compatibility. | ||
|
||
{% hint style="info" %} | ||
It is necessary to run the upgrade installer on each environment of your Umbraco site. This means that you need to repeat the steps below on each of your environments in order to complete the upgrade. | ||
{% endhint %} | ||
|
||
## Legacy Umbraco | ||
|
||
The steps outlined in this article apply to Umbraco version 10 and later versions. | ||
|
||
Are you upgrading to a minor version for Umbraco 6, 7, or 8? You can find the appropriate guide below: | ||
|
||
{% content-ref url="version-specific/minor-upgrades-for-umbraco-8.md" %} | ||
[minor-upgrades-for-umbraco-8.md](version-specific/minor-upgrades-for-umbraco-8.md) | ||
{% endcontent-ref %} | ||
|
||
{% content-ref url="version-specific/minor-upgrades-for-umbraco-7.md" %} | ||
[minor-upgrades-for-umbraco-7.md](version-specific/minor-upgrades-for-umbraco-7.md) | ||
{% endcontent-ref %} | ||
|
||
## Upgrade to a new Major | ||
|
||
You can upgrade to a new major version of Umbraco CMS directly by using NuGet. | ||
|
||
You must upgrade to the closest [Long-term Support (LTS) major](https://umbraco.com/products/knowledge-center/long-term-support-and-end-of-life/) version before upgrading to the latest version. For Umbraco 10, the closest long-term support version is Umbraco 13. Once the project is on Umbraco 13, you can move on to Umbraco 14. | ||
|
||
{% hint style="warning" %} | ||
Switching to a new major version of Umbraco CMS also means switching to a new .NET version. Ensure that any packages used on your site are compatible with this version before upgrading. | ||
|
||
The package compatibility can be checked on the package's download page. Locate the **Project compatibility** area and select **View details** to check version-specific compatibility. | ||
{% endhint %} | ||
|
||
### Choose the correct .NET version | ||
|
||
Use the table below to determine which .NET version to upgrade to when going through the steps below. | ||
|
||
| CMS version | .NET version | | ||
| ----------- | ------------ | | ||
| 16 | 9.0 | | ||
| 15 | 9.0 | | ||
| 14 | 8.0 | | ||
| 13 | 8.0 | | ||
| 12 | 7.0 | | ||
| 11 | 7.0 | | ||
| 10 | 6.0.5 | | ||
|
||
### Upgrade your project using Visual Studio | ||
|
||
{% hint style="info" %} | ||
If you are upgrading a Cloud project locally from version 14 to 15, remove the `Umbraco.Cloud.Cms.PublicAccess` and `Umbraco.Cloud.Identity.Cms` packages. For more details, see [Step 3: Upgrade the project locally using Visual Studio](https://docs.umbraco.com/umbraco-cloud/product-upgrades/major-upgrades#step-3-upgrade-the-project-locally-using-visual-studio) in the Umbraco Cloud Documentation. | ||
{% endhint %} | ||
|
||
It's recommended that you upgrade the site offline and test the upgrade fully before deploying it to the production environment. | ||
|
||
1. Stop your site in IIS to prevent any changes from being made while you are upgrading. | ||
2. Open your Umbraco project in Visual Studio. | ||
3. Right-click on the project name in the Solution Explorer and select **Properties**. | ||
4. Select the **.NET** version from the **Target Framework** drop-down. | ||
5. Go to **Tools** > **NuGet Package Manager** > **Manage NuGet Packages for Solution...** | ||
6. Go to the **Installed** tab in the NuGet Package Manager. | ||
7. Upgrade **Umbraco.Cms**. | ||
|
||
a. Select the correct version from the **Version** drop-down. | ||
|
||
b. Click **Install** to upgrade your project. | ||
|
||
{% hint style="info" %} | ||
If you have other packages like Umbraco Forms installed, upgrade them before upgrading **Umbraco.CMS**. Consult the [version-specific upgrade notes for Umbraco Forms](https://docs.umbraco.com/umbraco-forms/upgrading/version-specific) if relevant. | ||
{% endhint %} | ||
|
||
8. Make sure that your connection string has `TrustServerCertificate=True` to complete the upgrade successfully: | ||
|
||
{% code title="appsettings.json" %} | ||
```csharp | ||
"ConnectionStrings": { | ||
"umbracoDbDSN": "Server=YourLocalSQLServerHere;Database=NameOfYourDatabaseHere;User Id=NameOfYourUserHere;Password=YourPasswordHere;TrustServerCertificate=True" | ||
} | ||
``` | ||
{% endcode %} | ||
|
||
9. Restart your site in IIS, then build and run your project to finish the installation. | ||
|
||
{% hint style="info" %} | ||
Umbraco 13 and later versions use the [Minimal Hosting Model](https://github.com/umbraco/Umbraco-CMS/pull/14656). | ||
|
||
If you have added custom code to the `startup.cs` file, it is recommended to move that code into a Composer after upgrading. | ||
{% endhint %} | ||
|
||
{% hint style="warning" %} | ||
If your database experiences timeout issues after an upgrade, it might be due to the [ASP.NET Core Module's](https://learn.microsoft.com/en-us/aspnet/core/test/troubleshoot-azure-iis?#default-startup-limits) `startupTimeLimit` configuration. | ||
|
||
To fix the issue, try increasing the [`startupTimeLimit`](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/web-config?) in the `web.config` file. Additionally, you can set the [`Connection Timeout`](https://learn.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectiontimeout?) value in the [`ConnectionString`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring?) in the `appsettings.json` file. | ||
{% endhint %} | ||
|
||
### Potential issues and gotchas | ||
|
||
If you receive an error that **a deploy license is missing** even though you have a valid license, follow the guide below.  | ||
|
||
Google Chrome has aggressive caching, so when experiencing startup issues, clear the cache and cookies thoroughly. Ideally, this should be done for other browsers as well. | ||
|
||
Nudge the cache in Chrome following these steps: | ||
|
||
1. Open the developer tools (F12). | ||
2. Go to the settings (Cog icon). | ||
3. Ensure that "Disable cache (while DevTools is open)" is checked. | ||
4. Refresh the page, and the cache will be invalidated. | ||
5. Right-click the "reload" button next to your address bar and choose "Empty cache and hard reload". | ||
|
||
All caches and cookies have now been cleared from your Google Chrome browser. Generally, it is a good thing to do occasionally. | ||
|
||
## Upgrade to a new Minor | ||
|
||
NuGet installs the latest version of the package when you use the `dotnet add package` command unless you specify a package version: | ||
|
||
`dotnet add package Umbraco.Cms --version <VERSION>` | ||
|
||
Add a package reference to your project by executing the `dotnet add package Umbraco.Cms` command in the directory that contains your project file. | ||
|
||
Run `dotnet restore` to install the package. | ||
|
||
{% hint style="warning" %} | ||
**For Umbraco 9**\ | ||
If you are using SQL CE in your project, you need to run `dotnet add package Umbraco.Cms.SqlCe --version <VERSION>` before the `dotnet restore` command. From Umbraco 10, SQL CE has been replaced with SQLite, so a `dotnet restore` should be sufficient. If this is not working, then you need to run `dotnet add package Umbraco.Cms.Persistence.Sqlite --version <VERSION>` , and then `dotnet restore`. | ||
{% endhint %} | ||
|
||
When the command completes, open the `.csproj` file to make sure the package reference was updated: | ||
|
||
{% code title="YourProjectName.csproj" %} | ||
```xml | ||
<ItemGroup> | ||
<PackageReference Include="Umbraco.Cms" Version="x.x.x" /> | ||
</ItemGroup> | ||
``` | ||
{% endcode %} | ||
|
||
## Run an unattended upgrade | ||
|
||
When upgrading your Umbraco project, it is possible to enable the upgrade to run unattended. This means that you will not need to run through the installation wizard when upgrading. | ||
|
||
Below you will find the steps you need to take in order to upgrade your project unattended. | ||
|
||
{% hint style="info" %} | ||
Are you running a load-balanced setup with multiple servers and environments? | ||
|
||
Check out the section about [Unattended upgrades in a load-balanced setup](./#unattended-upgrades-in-a-load-balanced-setup). | ||
{% endhint %} | ||
|
||
### Enable the unattended upgrade feature | ||
|
||
1. Add the `Umbraco:Cms:Unattended:UpgradeUnattended` configuration key. | ||
2. Set the value of the key to `true`. | ||
|
||
{% code title="appsettings.json" %} | ||
```json | ||
{ | ||
"Umbraco": { | ||
"CMS": { | ||
"Unattended": { | ||
"UpgradeUnattended": true | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
{% endcode %} | ||
|
||
### Run the upgrade | ||
|
||
With the correct configuration applied, the project will be upgraded on the next boot. | ||
|
||
#### Boot order | ||
|
||
The Runtime level uses `Run` instead of `Upgrade` to allow the website to continue to boot up directly after the migration is run. This happens instead of initiating the otherwise required restart. | ||
|
||
{% hint style="info" %} | ||
The upgrade is run after Composers but before Components, and the `UmbracoApplicationStartingNotification`. This is because the migration requires services that are registered in Composers, and Components require that Umbraco and the database are ready. | ||
{% endhint %} | ||
|
||
### Unattended upgrades in a load-balanced setup | ||
|
||
Follow the steps outlined below to use unattended upgrades in a load-balanced setup. | ||
|
||
1. [Upgrade Umbraco via NuGet](./#upgrade-to-a-new-major). | ||
2. Deploy to all environments. | ||
3. Set the `Umbraco:CMS:Unattended:UpgradeUnattended` configuration key to `true` for **the Main server only**. | ||
4. Boot the Main server, and the upgrade will run automatically. | ||
5. Wait for the upgrade to complete. | ||
6. Boot the Read-Only servers and ensure they do not show the “upgrade required” screen. | ||
Then we have step-by-step [upgrade instructions](./upgrade-details.md) for how to update your project to a newer version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we refer to where this communication is made, e.g., Release Notes and Announcements on GitHub, and Release Blog Post on umbraco.com?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do have that actually - in the sentence: