diff --git a/16/umbraco-cms/SUMMARY.md b/16/umbraco-cms/SUMMARY.md index 74944bf5458..fd7af5e9dc7 100644 --- a/16/umbraco-cms/SUMMARY.md +++ b/16/umbraco-cms/SUMMARY.md @@ -25,7 +25,7 @@ * [Unattended Installs](fundamentals/setup/install/unattended-install.md) * [Upgrade your project](fundamentals/setup/upgrading/README.md) * [Upgrades in Umbraco](fundamentals/setup/upgrading/upgrade-introduction.md) - * [Upgrade Instructions](fundamentals/setup/upgrading/upgrade-details.md) + * [Upgrade Details](fundamentals/setup/upgrading/upgrade-details.md) * [Version Specific Upgrades](fundamentals/setup/upgrading/version-specific/README.md) * [Upgrade from Umbraco 8 to the latest version](fundamentals/setup/upgrading/version-specific/upgrade-from-8-to-latest.md) * [Migrate content to Umbraco 15](fundamentals/setup/upgrading/version-specific/migrate-content-to-umbraco-15.md) @@ -33,6 +33,7 @@ * [Minor upgrades for Umbraco 8](fundamentals/setup/upgrading/version-specific/minor-upgrades-for-umbraco-8.md) * [Upgrade to Umbraco 7](fundamentals/setup/upgrading/version-specific/upgrade-to-umbraco-7.md) * [Minor upgrades for Umbraco 7](fundamentals/setup/upgrading/version-specific/minor-upgrades-for-umbraco-7.md) + * [Upgrade Unattended](fundamentals/setup/upgrading/upgrade-unattended.md) * [Server setup](fundamentals/setup/server-setup/README.md) * [Running Umbraco On Azure Web Apps](fundamentals/setup/server-setup/azure-web-apps.md) * [Hosting Umbraco in IIS](fundamentals/setup/server-setup/iis.md) diff --git a/16/umbraco-cms/fundamentals/setup/upgrading/README.md b/16/umbraco-cms/fundamentals/setup/upgrading/README.md index 7e8176f4e69..7a3dd19959e 100644 --- a/16/umbraco-cms/fundamentals/setup/upgrading/README.md +++ b/16/umbraco-cms/fundamentals/setup/upgrading/README.md @@ -1,11 +1,15 @@ --- -description: This is the guide for upgrading existing Umbraco installations. +description: Choose the guide fitting your upgrade situation and learn more about the recommended approach. --- # Upgrade your project -In this section, you will find everything you need to upgrade your Umbraco CMS project. +In this section, you will find resources to upgrade your Umbraco CMS project. -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 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. -Then we have step-by-step [upgrade instructions](./upgrade-details.md) for how to update your project to a newer version. \ No newline at end of file +## Upgrade Guides + +* [Upgrade details: Minor and Major upgrades](upgrade-details.md) +* [Upgrade Unattended](upgrade-unattended.md) +* [Version Specific upgrade notes](version-specific/README.md) diff --git a/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-details.md b/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-details.md index 7a7e44fb4de..f6fbb368de3 100644 --- a/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-details.md +++ b/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-details.md @@ -1,19 +1,16 @@ --- -description: Describes how to upgrading existing installations to new versions. +description: Describes how to upgrade existing installations to new versions. --- -# Upgrade Instructions +# Upgrade Details In this article, you will find everything you need to upgrade your Umbraco CMS project. -If you are new to upgrades, be sure to read the [introduction to upgrades in Umbraco first](./upgrade-introduction.md). +If you are new to upgrades, be sure to read the [upgrade introduction article](./upgrade-introduction.md) first. -You will find instructions on how to upgrade to a new minor or major version as well as how to run upgrades unattended. - -* [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) -* [Legacy Umbraco](./#legacy-umbraco) +* [Upgrade to a new Major](#upgrade-to-a-new-major) +* [Upgrade to a new Minor](#upgrade-to-a-new-minor) +* [Legacy Umbraco](#legacy-umbraco) ## Upgrade to a new Major @@ -134,60 +131,6 @@ When the command completes, open the `.csproj` file to make sure the package ref ``` {% 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. - ## Legacy Umbraco 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 {% 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 %} - diff --git a/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-unattended.md b/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-unattended.md new file mode 100644 index 00000000000..dc5e184078e --- /dev/null +++ b/16/umbraco-cms/fundamentals/setup/upgrading/upgrade-unattended.md @@ -0,0 +1,59 @@ +--- +description: Learn how to enable unattended upgrades, allowing your project to upgrade without your interference. +--- + +# Upgrade Unattended + +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. + +{% 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-details.md#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.