You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 16/umbraco-cms/fundamentals/setup/upgrading/README.md
+26-31Lines changed: 26 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ You will find instructions on how to upgrade to a new minor or major version as
17
17
18
18
The following lists a few things to be aware of before initiating an upgrade of your Umbraco CMS project.
19
19
20
-
* 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.
21
-
*Check if your setup meets the [requirements](../requirements.md) for the new versions you will be upgrading your project to.
22
-
* 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.
20
+
* 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.
21
+
*Ensure your setup meets the [requirements](../requirements.md) for the new versions you will be upgrading your project to.
22
+
* 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.
23
23
* 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.
24
24
25
25
{% hint style="info" %}
@@ -28,9 +28,9 @@ It is necessary to run the upgrade installer on each environment of your Umbraco
28
28
29
29
## Legacy Umbraco
30
30
31
-
The steps outlined in this article apply to modern Umbraco from version 10 and later versions.
31
+
The steps outlined in this article apply to Umbraco version 10 and later versions.
32
32
33
-
Are you upgrading to a minor for Umbraco 6, 7, or 8 you can find the appropriate guide below:
33
+
Are you upgrading to a minor version for Umbraco 6, 7, or 8? You can find the appropriate guide below:
@@ -42,12 +42,12 @@ Are you upgrading to a minor for Umbraco 6, 7, or 8 you can find the appropriate
42
42
43
43
## Upgrade to a new Major
44
44
45
-
You can upgrade to a new major of Umbraco CMS directly by using NuGet.
45
+
You can upgrade to a new major version of Umbraco CMS directly by using NuGet.
46
46
47
-
It is recommended that you 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 upgraded to Umbraco 13, you can upgrade to Umbraco 14.
47
+
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.
48
48
49
49
{% hint style="warning" %}
50
-
Switching to a new major of Umbraco CMS also means switching to a new .NET version. You need to make sure that any packages used on your site are compatible with this version before upgrading.
50
+
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.
51
51
52
52
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.
53
53
{% endhint %}
@@ -79,39 +79,37 @@ It's recommended that you upgrade the site offline and test the upgrade fully be
79
79
3. Right-click on the project name in the Solution Explorer and select **Properties**.
80
80
4. Select the **.NET** version from the **Target Framework** drop-down.
81
81
5. Go to **Tools** > **NuGet Package Manager** > **Manage NuGet Packages for Solution...**
82
-
6. Go to the **Installed** tab in the NuGet Package manager.
82
+
6. Go to the **Installed** tab in the NuGet Package Manager.
83
83
7. Upgrade **Umbraco.Cms**.
84
84
85
85
a. Select the correct version from the **Version** drop-down.
86
86
87
87
b. Click **Install** to upgrade your project.
88
88
89
89
{% hint style="info" %}
90
-
If you have other packages like Umbraco Forms installed, upgrade them before upgrading **Umbraco.CMS**. Consult the [versionspecific upgrade notes for Umbraco Forms](https://docs.umbraco.com/umbraco-forms/upgrading/version-specific) if relevant.
90
+
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.
91
91
{% endhint %}
92
92
93
-
8. Make sure that your connection string has `TrustServerCertificate=True`in order to complete the upgrade successfully:
93
+
8. Make sure that your connection string has `TrustServerCertificate=True` to complete the upgrade successfully:
9. Restart your site in IIS, then build and run your project to finish the installation.
106
104
107
105
{% hint style="info" %}
108
-
Umbraco 13 and later versions uses the [Minimal Hosting Model](https://github.com/umbraco/Umbraco-CMS/pull/14656).
106
+
Umbraco 13 and later versions use the [Minimal Hosting Model](https://github.com/umbraco/Umbraco-CMS/pull/14656).
109
107
110
108
If you have added custom code to the `startup.cs` file, it is recommended to move that code into a Composer after upgrading.
111
109
{% endhint %}
112
110
113
111
{% hint style="warning" %}
114
-
If your database experiences timeout issues after an upgrade, it might be due to [ASP.NET Core Module's](https://learn.microsoft.com/en-us/aspnet/core/test/troubleshoot-azure-iis?#default-startup-limits)'startupTimeLimit' configuration.
112
+
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.
115
113
116
114
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.
117
115
{% endhint %}
@@ -127,19 +125,18 @@ Add a package reference to your project by executing the `dotnet add package Umb
127
125
Run `dotnet restore` to install the package.
128
126
129
127
{% hint style="warning" %}
130
-
For v9: If you are using SQL CE in your project you will need to run `dotnet add package Umbraco.Cms.SqlCe --version <VERSION>` before running the `dotnet restore` command. From v10, SQL CE has been replaced with SQLite so a `dotnet restore` should be sufficient. If this is not working then you will need to run `dotnet add package Umbraco.Cms.Persistence.Sqlite --version <VERSION>` and then `dotnet restore`.
128
+
**For Umbraco 9**\
129
+
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`.
131
130
{% endhint %}
132
131
133
-
When the command completes, open the **.csproj** file to make sure the package reference was updated:
134
-
135
-
{% code title=".csproj" %}
132
+
When the command completes, open the `.csproj` file to make sure the package reference was updated:
@@ -149,9 +146,9 @@ When upgrading your Umbraco project, it is possible to enable the upgrade to run
149
146
Below you will find the steps you need to take in order to upgrade your project unattended.
150
147
151
148
{% hint style="info" %}
152
-
Are you running a loadbalanced setup with multiple servers and environments?
149
+
Are you running a load-balanced setup with multiple servers and environments?
153
150
154
-
Check out the section about [Unattended upgrades in a loadbalanced setup](./#unattended-upgrades-in-a-load-balanced-setup).
151
+
Check out the section about [Unattended upgrades in a load-balanced setup](./#unattended-upgrades-in-a-load-balanced-setup).
155
152
{% endhint %}
156
153
157
154
### Enable the unattended upgrade feature
@@ -160,7 +157,6 @@ Check out the section about [Unattended upgrades in a load balanced setup](./#un
160
157
2. Set the value of the key to `true`.
161
158
162
159
{% code title="appsettings.json" %}
163
-
164
160
```json
165
161
{
166
162
"Umbraco": {
@@ -172,7 +168,6 @@ Check out the section about [Unattended upgrades in a load balanced setup](./#un
172
168
}
173
169
}
174
170
```
175
-
176
171
{% endcode %}
177
172
178
173
### Run the upgrade
@@ -181,19 +176,19 @@ With the correct configuration applied, the project will be upgraded on the next
181
176
182
177
#### Boot order
183
178
184
-
The Runtime level will use`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.
179
+
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.
185
180
186
181
{% hint style="info" %}
187
-
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.
182
+
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.
188
183
{% endhint %}
189
184
190
-
### Unattended upgrades in a loadbalanced setup
185
+
### Unattended upgrades in a load-balanced setup
191
186
192
-
Follow the steps outlined below to use unattended upgrades in a loadbalanced setup.
187
+
Follow the steps outlined below to use unattended upgrades in a load-balanced setup.
193
188
194
-
1. Upgrade Umbraco via NuGet ([see instructions above](./#upgrade-to-a-new-major))
189
+
1.[Upgrade Umbraco via NuGet](./#upgrade-to-a-new-major).
195
190
2. Deploy to all environments.
196
191
3. Set the `Umbraco:CMS:Unattended:UpgradeUnattended` configuration key to `true` for **the Main server only**.
197
-
4. Boot the Main server and the upgrade will run automatically.
192
+
4. Boot the Main server, and the upgrade will run automatically.
198
193
5. Wait for the upgrade to complete.
199
-
6. Boot the Read-Only servers and make sure they do not show the “upgrade required” screen.
194
+
6. Boot the Read-Only servers and ensure they do not show the “upgrade required” screen.
0 commit comments