Skip to content

Commit 87d2292

Browse files
authored
Merge pull request #7326 from umbraco/cms/UpgradeDocs
A small restructure of the Upgrade Documentation for CMS
2 parents f6fab99 + 1c6060a commit 87d2292

File tree

4 files changed

+75
-69
lines changed

4 files changed

+75
-69
lines changed

16/umbraco-cms/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@
2525
* [Unattended Installs](fundamentals/setup/install/unattended-install.md)
2626
* [Upgrade your project](fundamentals/setup/upgrading/README.md)
2727
* [Upgrades in Umbraco](fundamentals/setup/upgrading/upgrade-introduction.md)
28-
* [Upgrade Instructions](fundamentals/setup/upgrading/upgrade-details.md)
28+
* [Upgrade Details](fundamentals/setup/upgrading/upgrade-details.md)
2929
* [Version Specific Upgrades](fundamentals/setup/upgrading/version-specific/README.md)
3030
* [Upgrade from Umbraco 8 to the latest version](fundamentals/setup/upgrading/version-specific/upgrade-from-8-to-latest.md)
3131
* [Migrate content to Umbraco 15](fundamentals/setup/upgrading/version-specific/migrate-content-to-umbraco-15.md)
3232
* [Migrate content to Umbraco 8](fundamentals/setup/upgrading/version-specific/migrate-content-to-umbraco-8.md)
3333
* [Minor upgrades for Umbraco 8](fundamentals/setup/upgrading/version-specific/minor-upgrades-for-umbraco-8.md)
3434
* [Upgrade to Umbraco 7](fundamentals/setup/upgrading/version-specific/upgrade-to-umbraco-7.md)
3535
* [Minor upgrades for Umbraco 7](fundamentals/setup/upgrading/version-specific/minor-upgrades-for-umbraco-7.md)
36+
* [Upgrade Unattended](fundamentals/setup/upgrading/upgrade-unattended.md)
3637
* [Server setup](fundamentals/setup/server-setup/README.md)
3738
* [Running Umbraco On Azure Web Apps](fundamentals/setup/server-setup/azure-web-apps.md)
3839
* [Hosting Umbraco in IIS](fundamentals/setup/server-setup/iis.md)
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
2-
description: This is the guide for upgrading existing Umbraco installations.
2+
description: Choose the guide fitting your upgrade situation and learn more about the recommended approach.
33
---
44

55
# Upgrade your project
66

7-
In this section, you will find everything you need to upgrade your Umbraco CMS project.
7+
In this section, you will find resources to upgrade your Umbraco CMS project.
88

9-
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.
9+
Before upgrading, it is recommended to **read the [upgrade introduction](./upgrade-introduction.md) article**. This will give you an understanding of what goes on and the different topics you need to consider.
1010

11-
Then we have step-by-step [upgrade instructions](./upgrade-details.md) for how to update your project to a newer version.
11+
## Upgrade Guides
12+
13+
* [Upgrade details: Minor and Major upgrades](upgrade-details.md)
14+
* [Upgrade Unattended](upgrade-unattended.md)
15+
* [Version Specific upgrade notes](version-specific/README.md)

16/umbraco-cms/fundamentals/setup/upgrading/upgrade-details.md

Lines changed: 6 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
---
2-
description: Describes how to upgrading existing installations to new versions.
2+
description: Describes how to upgrade existing installations to new versions.
33
---
44

5-
# Upgrade Instructions
5+
# Upgrade Details
66

77
In this article, you will find everything you need to upgrade your Umbraco CMS project.
88

9-
If you are new to upgrades, be sure to read the [introduction to upgrades in Umbraco first](./upgrade-introduction.md).
9+
If you are new to upgrades, be sure to read the [upgrade introduction article](./upgrade-introduction.md) first.
1010

11-
You will find instructions on how to upgrade to a new minor or major version as well as how to run upgrades unattended.
12-
13-
* [Upgrade to a new Major](./#upgrade-to-a-new-major)
14-
* [Upgrade to a new Minor](./#upgrade-to-a-new-minor)
15-
* [Run an unattended upgrade](./#run-an-unattended-upgrade)
16-
* [Legacy Umbraco](./#legacy-umbraco)
11+
* [Upgrade to a new Major](#upgrade-to-a-new-major)
12+
* [Upgrade to a new Minor](#upgrade-to-a-new-minor)
13+
* [Legacy Umbraco](#legacy-umbraco)
1714

1815
## Upgrade to a new Major
1916

@@ -134,60 +131,6 @@ When the command completes, open the `.csproj` file to make sure the package ref
134131
```
135132
{% endcode %}
136133

137-
## Run an unattended upgrade
138-
139-
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.
140-
141-
Below you will find the steps you need to take in order to upgrade your project unattended.
142-
143-
{% hint style="info" %}
144-
Are you running a load-balanced setup with multiple servers and environments?
145-
146-
Check out the section about [Unattended upgrades in a load-balanced setup](./#unattended-upgrades-in-a-load-balanced-setup).
147-
{% endhint %}
148-
149-
### Enable the unattended upgrade feature
150-
151-
1. Add the `Umbraco:Cms:Unattended:UpgradeUnattended` configuration key.
152-
2. Set the value of the key to `true`.
153-
154-
{% code title="appsettings.json" %}
155-
```json
156-
{
157-
"Umbraco": {
158-
"CMS": {
159-
"Unattended": {
160-
"UpgradeUnattended": true
161-
}
162-
}
163-
}
164-
}
165-
```
166-
{% endcode %}
167-
168-
### Run the upgrade
169-
170-
With the correct configuration applied, the project will be upgraded on the next boot.
171-
172-
#### Boot order
173-
174-
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.
175-
176-
{% hint style="info" %}
177-
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.
178-
{% endhint %}
179-
180-
### Unattended upgrades in a load-balanced setup
181-
182-
Follow the steps outlined below to use unattended upgrades in a load-balanced setup.
183-
184-
1. [Upgrade Umbraco via NuGet](./#upgrade-to-a-new-major).
185-
2. Deploy to all environments.
186-
3. Set the `Umbraco:CMS:Unattended:UpgradeUnattended` configuration key to `true` for **the Main server only**.
187-
4. Boot the Main server, and the upgrade will run automatically.
188-
5. Wait for the upgrade to complete.
189-
6. Boot the Read-Only servers and ensure they do not show the “upgrade required” screen.
190-
191134
## Legacy Umbraco
192135

193136
The steps outlined in this article apply to Umbraco version 10 and later versions.
@@ -201,4 +144,3 @@ Are you upgrading to a minor version for Umbraco 6, 7, or 8? You can find the ap
201144
{% content-ref url="version-specific/minor-upgrades-for-umbraco-7.md" %}
202145
[minor-upgrades-for-umbraco-7.md](version-specific/minor-upgrades-for-umbraco-7.md)
203146
{% endcontent-ref %}
204-
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
description: Learn how to enable unattended upgrades, allowing your project to upgrade without your interference.
3+
---
4+
5+
# Upgrade Unattended
6+
7+
When upgrading your Umbraco project, you can enable the upgrade to run unattended. This means that you will not need to run through the installation wizard when upgrading.
8+
9+
{% hint style="info" %}
10+
11+
Are you running a load-balanced setup with multiple servers and environments?
12+
13+
Check out the section about [Unattended upgrades in a load-balanced setup](#unattended-upgrades-in-a-load-balanced-setup).
14+
15+
{% endhint %}
16+
17+
## Enable the unattended upgrade feature
18+
19+
1. Add the `Umbraco:Cms:Unattended:UpgradeUnattended` configuration key.
20+
2. Set the value of the key to `true`.
21+
22+
{% code title="appsettings.json" %}
23+
24+
```json
25+
{
26+
"Umbraco": {
27+
"CMS": {
28+
"Unattended": {
29+
"UpgradeUnattended": true
30+
}
31+
}
32+
}
33+
}
34+
```
35+
36+
{% endcode %}
37+
38+
## Run the upgrade
39+
40+
With the correct configuration applied, the project will be upgraded on the next boot.
41+
42+
### Boot order
43+
44+
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.
45+
46+
{% hint style="info" %}
47+
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.
48+
{% endhint %}
49+
50+
## Unattended upgrades in a load-balanced setup
51+
52+
Follow the steps outlined below to use unattended upgrades in a load-balanced setup.
53+
54+
1. [Upgrade Umbraco via NuGet](upgrade-details.md#upgrade-to-a-new-major).
55+
2. Deploy to all environments.
56+
3. Set the `Umbraco:CMS:Unattended:UpgradeUnattended` configuration key to `true` for the **Main server** only.
57+
4. Boot the Main server, and the upgrade will run automatically.
58+
5. Wait for the upgrade to complete.
59+
6. Boot the **Read-Only** servers and ensure they do not show the “Upgrade Required” screen.

0 commit comments

Comments
 (0)