-
Notifications
You must be signed in to change notification settings - Fork 811
A small restructure of the Upgrade Documentation for CMS #7326
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
dd54984
Moved Unattended section into new article
sofietoft 6fc9dc9
Add links from landing page to sub articles
sofietoft d08718d
Update README.md
sofietoft 78053d9
Update upgrade-unattended.md
sofietoft 2074847
Update README.md
sofietoft e01579d
Update upgrade-details.md
sofietoft 7356df5
Update SUMMARY.md
sofietoft f0e4936
Update SUMMARY.md
sofietoft 71217d3
Apply suggestions from code review
sofietoft 1c6060a
Update links
sofietoft File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| ## Upgrade Guides | ||
|
|
||
| * [Upgrade details: Minor and Major upgrades](upgrade-details.md) | ||
| * [Upgrade Unattended](upgrade-unattended.md) | ||
| * [Version Specific upgrade notes](version-specific/README.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
16/umbraco-cms/fundamentals/setup/upgrading/upgrade-unattended.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.