Skip to content

Commit afe6fc5

Browse files
Sofie Toft Kristensengitbook-bot
authored andcommitted
GITBOOK-16: No subject
1 parent 4f62f5c commit afe6fc5

File tree

1 file changed

+26
-31
lines changed
  • 16/umbraco-cms/fundamentals/setup/upgrading

1 file changed

+26
-31
lines changed

16/umbraco-cms/fundamentals/setup/upgrading/README.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You will find instructions on how to upgrade to a new minor or major version as
1717

1818
The following lists a few things to be aware of before initiating an upgrade of your Umbraco CMS project.
1919

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.
2323
* 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.
2424

2525
{% hint style="info" %}
@@ -28,9 +28,9 @@ It is necessary to run the upgrade installer on each environment of your Umbraco
2828

2929
## Legacy Umbraco
3030

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.
3232

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:
3434

3535
{% content-ref url="version-specific/minor-upgrades-for-umbraco-8.md" %}
3636
[minor-upgrades-for-umbraco-8.md](version-specific/minor-upgrades-for-umbraco-8.md)
@@ -42,12 +42,12 @@ Are you upgrading to a minor for Umbraco 6, 7, or 8 you can find the appropriate
4242

4343
## Upgrade to a new Major
4444

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.
4646

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.
4848

4949
{% 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.
5151

5252
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.
5353
{% endhint %}
@@ -79,39 +79,37 @@ It's recommended that you upgrade the site offline and test the upgrade fully be
7979
3. Right-click on the project name in the Solution Explorer and select **Properties**.
8080
4. Select the **.NET** version from the **Target Framework** drop-down.
8181
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.
8383
7. Upgrade **Umbraco.Cms**.
8484

8585
a. Select the correct version from the **Version** drop-down.
8686

8787
b. Click **Install** to upgrade your project.
8888

8989
{% hint style="info" %}
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.
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.
9191
{% endhint %}
9292

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:
9494

9595
{% code title="appsettings.json" %}
96-
9796
```csharp
9897
"ConnectionStrings": {
9998
"umbracoDbDSN": "Server=YourLocalSQLServerHere;Database=NameOfYourDatabaseHere;User Id=NameOfYourUserHere;Password=YourPasswordHere;TrustServerCertificate=True"
10099
}
101100
```
102-
103101
{% endcode %}
104102

105103
9. Restart your site in IIS, then build and run your project to finish the installation.
106104

107105
{% 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).
109107

110108
If you have added custom code to the `startup.cs` file, it is recommended to move that code into a Composer after upgrading.
111109
{% endhint %}
112110

113111
{% 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.
115113

116114
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.
117115
{% endhint %}
@@ -127,19 +125,18 @@ Add a package reference to your project by executing the `dotnet add package Umb
127125
Run `dotnet restore` to install the package.
128126

129127
{% 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`.
131130
{% endhint %}
132131

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:
136133

134+
{% code title="YourProjectName.csproj" %}
137135
```xml
138136
<ItemGroup>
139137
<PackageReference Include="Umbraco.Cms" Version="x.x.x" />
140138
</ItemGroup>
141139
```
142-
143140
{% endcode %}
144141

145142
## Run an unattended upgrade
@@ -149,9 +146,9 @@ When upgrading your Umbraco project, it is possible to enable the upgrade to run
149146
Below you will find the steps you need to take in order to upgrade your project unattended.
150147

151148
{% hint style="info" %}
152-
Are you running a load balanced setup with multiple servers and environments?
149+
Are you running a load-balanced setup with multiple servers and environments?
153150

154-
Check out the section about [Unattended upgrades in a load balanced 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).
155152
{% endhint %}
156153

157154
### Enable the unattended upgrade feature
@@ -160,7 +157,6 @@ Check out the section about [Unattended upgrades in a load balanced setup](./#un
160157
2. Set the value of the key to `true`.
161158

162159
{% code title="appsettings.json" %}
163-
164160
```json
165161
{
166162
"Umbraco": {
@@ -172,7 +168,6 @@ Check out the section about [Unattended upgrades in a load balanced setup](./#un
172168
}
173169
}
174170
```
175-
176171
{% endcode %}
177172

178173
### Run the upgrade
@@ -181,19 +176,19 @@ With the correct configuration applied, the project will be upgraded on the next
181176

182177
#### Boot order
183178

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.
185180

186181
{% 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.
188183
{% endhint %}
189184

190-
### Unattended upgrades in a load balanced setup
185+
### Unattended upgrades in a load-balanced setup
191186

192-
Follow the steps outlined below to use unattended upgrades in a load balanced setup.
187+
Follow the steps outlined below to use unattended upgrades in a load-balanced setup.
193188

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).
195190
2. Deploy to all environments.
196191
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.
198193
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

Comments
 (0)