diff --git a/docs/unraid-os/advanced-configurations/_category_.json b/docs/unraid-os/advanced-configurations/_category_.json index 408047b45f8..ffa6edba2af 100644 --- a/docs/unraid-os/advanced-configurations/_category_.json +++ b/docs/unraid-os/advanced-configurations/_category_.json @@ -4,4 +4,4 @@ "link": { "type": "generated-index" } - } \ No newline at end of file + } diff --git a/docs/unraid-os/download_list.mdx b/docs/unraid-os/download_list.mdx index 5d8d5f8a7fb..1ee577d1aba 100644 --- a/docs/unraid-os/download_list.mdx +++ b/docs/unraid-os/download_list.mdx @@ -1,12 +1,14 @@ --- -sidebar_position: 7 -title: Version history +sidebar_position: 9 +title: Version Archive --- import {VersionsTable} from '@site/src/components/VersionsTable'; -# Version history +# Version Archive -Need the USB Creator? [Getting Started With Unraid](https://unraid.net/getting-started) +Use this archive to find release notes and download links for Unraid OS versions. To update an existing server, use the built-in updater; see the [standard update process](./updating-unraid/index.mdx#standard-update-process) for steps. To create a new boot device, use the [Unraid USB Creator](https://unraid.net/download). + +If you are deciding which release to install, start with [Unraid OS release types](./updating-unraid/release-types.mdx). diff --git a/docs/unraid-os/release-notes/7.2.0.md b/docs/unraid-os/release-notes/7.2.0.md index 4b0ac3f7aa9..fd6706f9148 100644 --- a/docs/unraid-os/release-notes/7.2.0.md +++ b/docs/unraid-os/release-notes/7.2.0.md @@ -6,7 +6,7 @@ Note that some plugins may have visual issues in this release; please give plugi ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](../../unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.2.1.md b/docs/unraid-os/release-notes/7.2.1.md index fa346044f3c..545377e4688 100644 --- a/docs/unraid-os/release-notes/7.2.1.md +++ b/docs/unraid-os/release-notes/7.2.1.md @@ -4,7 +4,7 @@ This is a small update with some great fixes and improvements. ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](../../unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.2.2.md b/docs/unraid-os/release-notes/7.2.2.md index 60177c9f35c..451e75e401e 100644 --- a/docs/unraid-os/release-notes/7.2.2.md +++ b/docs/unraid-os/release-notes/7.2.2.md @@ -8,7 +8,7 @@ If you are on 7.2.0 or earlier you can skip straight to 7.2.2. ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](../../unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.2.3.md b/docs/unraid-os/release-notes/7.2.3.md index 52e8df73654..107b2cc858f 100644 --- a/docs/unraid-os/release-notes/7.2.3.md +++ b/docs/unraid-os/release-notes/7.2.3.md @@ -4,7 +4,7 @@ This is a security and bugfix release, recommended for all users. ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](../../unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](../../unraid-os/troubleshooting/licensing-faq.mdx#license-types--features)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.2.4.md b/docs/unraid-os/release-notes/7.2.4.md index 03f5837e9f5..7ea4ed88c79 100644 --- a/docs/unraid-os/release-notes/7.2.4.md +++ b/docs/unraid-os/release-notes/7.2.4.md @@ -6,7 +6,7 @@ This release includes critical security updates and bug fixes. ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](/unraid-os/system-administration/maintain-and-update/upgrading-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.2.5.md b/docs/unraid-os/release-notes/7.2.5.md index 652f5a2b23f..cdc335d48a6 100644 --- a/docs/unraid-os/release-notes/7.2.5.md +++ b/docs/unraid-os/release-notes/7.2.5.md @@ -8,7 +8,7 @@ This release is recommended for all 7.2.x users. ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](/unraid-os/system-administration/maintain-and-update/upgrading-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? ### Known issues diff --git a/docs/unraid-os/release-notes/7.3.0.md b/docs/unraid-os/release-notes/7.3.0.md index 3f5c6606f1c..f0fbf01e108 100644 --- a/docs/unraid-os/release-notes/7.3.0.md +++ b/docs/unraid-os/release-notes/7.3.0.md @@ -4,13 +4,15 @@ This release candidate includes onboarding and internal boot, TPM-based licensin This is RELEASE CANDIDATE software. Please use on test servers only. +Curious about what our different release types are? See [Unraid OS release types](/unraid-os/updating-unraid/release-types/). + ## Upgrading -For step-by-step instructions, see [Upgrading Unraid](/unraid-os/system-administration/maintain-and-update/upgrading-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? ### Known issues -See [Unraid OS Prerelease (Bugs & Feedback)](https://product.unraid.net/b/unraid-os-prerelease-bugs-feedback) for issues reported by other testers. +See [Unraid OS Pre-release (Bugs & Feedback)](https://product.unraid.net/b/unraid-os-prerelease-bugs-feedback) for issues reported by other testers. - During internal boot setup, the WebGUI may show **Array Offline** while internal boot configures. **DO NOT** manually restart or remove your flash drive during this process. - Internal boot requires boot storage that can be accessed by in-tree Linux drivers during startup. Devices that require third-party drivers or post-boot configuration cannot be used for internal boot. @@ -22,10 +24,10 @@ See [Unraid OS Prerelease (Bugs & Feedback)](https://product.unraid.net/b/unraid ### Rolling back -- If you already enabled internal boot or switched to TPM-based licensing while testing the 7.3 prerelease, you can roll back to `7.3.0-beta.1` without issue. +- If you already enabled internal boot or switched to TPM-based licensing while testing the 7.3 pre-release, you can roll back to `7.3.0-beta.1` without issue. - Do not roll back to `7.2.4` or earlier after enabling internal boot or TPM-based licensing. - If you upgrade ZFS pool features, earlier Unraid releases may not be able to import those pools. -- If you need to roll back, follow the normal prerelease rollback process before moving between builds. +- If you need to roll back, follow the normal pre-release rollback process before moving between builds. If you are considering any rollback path below `7.3.0-beta.1`, also see the [7.2.4 release notes](/unraid-os/release-notes/7.2.4/). @@ -158,7 +160,7 @@ To proactively switch to TPM-based licensing, see [How can I move from flash-bas - xfsprogs: version 6.18.0 - zfs: version 2.4.1 -## Prerelease tester notes +## Pre-release tester notes ### CHANGES FROM BETA.2 diff --git a/docs/unraid-os/release-notes/_category_.json b/docs/unraid-os/release-notes/_category_.json index 4e9fe407582..aa96f9ecd1b 100644 --- a/docs/unraid-os/release-notes/_category_.json +++ b/docs/unraid-os/release-notes/_category_.json @@ -1,6 +1,6 @@ { "label": "Release notes", - "position": 6, + "position": 8, "link": { "type": "generated-index", "description": "Unraid Release Notes" diff --git a/docs/unraid-os/system-administration/_category_.json b/docs/unraid-os/system-administration/_category_.json index 4a8cbe116c4..5edef43eef4 100644 --- a/docs/unraid-os/system-administration/_category_.json +++ b/docs/unraid-os/system-administration/_category_.json @@ -4,4 +4,4 @@ "link": { "type": "generated-index" } - } \ No newline at end of file + } diff --git a/docs/unraid-os/system-administration/maintain-and-update/_category_.json b/docs/unraid-os/system-administration/maintain-and-update/_category_.json index 00221b87b61..f931c8aeb65 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/_category_.json +++ b/docs/unraid-os/system-administration/maintain-and-update/_category_.json @@ -1,7 +1,4 @@ { - "label": "Maintain and update", - "position": 2, - "link": { - "type": "generated-index" - } - } \ No newline at end of file + "label": "Maintenance", + "position": 2 + } diff --git a/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx b/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx index 020b5e95b01..f49c071a5f6 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx +++ b/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 sidebar_label: Changing the boot device --- diff --git a/docs/unraid-os/system-administration/maintain-and-update/partials/upgrade-modern.mdx b/docs/unraid-os/system-administration/maintain-and-update/partials/upgrade-modern.mdx deleted file mode 100644 index 811cd5f4366..00000000000 --- a/docs/unraid-os/system-administration/maintain-and-update/partials/upgrade-modern.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Upgrading Unraid is done using the new **Update OS tool** with a user-friendly interface: - -1. In the %%WebGUI|web-gui%%, click the top-right dropdown menu and select **Check for Update** or navigate to ***Tools → Update OS***. -2. Choose the **Stable** channel for stable releases, or the **Next** channel for betas and RCs. -3. Click **View Changelog to Start Update**. The Changelog will appear for you to review before hitting **Continue**. -4. Click **Confirm and start update** to apply the latest stable release. -5. When prompted, reboot your server to complete the upgrade. - -:::note - -You may need to log into your Unraid account to access updates, especially for "Next" branch releases. - -::: diff --git a/docs/unraid-os/troubleshooting/_category_.json b/docs/unraid-os/troubleshooting/_category_.json index 04a750cf02f..d4489573a50 100644 --- a/docs/unraid-os/troubleshooting/_category_.json +++ b/docs/unraid-os/troubleshooting/_category_.json @@ -1,4 +1,4 @@ { "label": "Troubleshooting", "position": 5 -} \ No newline at end of file +} diff --git a/docs/unraid-os/updating-unraid/_category_.json b/docs/unraid-os/updating-unraid/_category_.json new file mode 100644 index 00000000000..431532f2630 --- /dev/null +++ b/docs/unraid-os/updating-unraid/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Updating Unraid", + "position": 7, + "link": { + "type": "doc", + "id": "unraid-os/updating-unraid/index" + } +} diff --git a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx b/docs/unraid-os/updating-unraid/index.mdx similarity index 84% rename from docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx rename to docs/unraid-os/updating-unraid/index.mdx index d2cabc1f0d3..85040c78a70 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx +++ b/docs/unraid-os/updating-unraid/index.mdx @@ -1,6 +1,6 @@ --- -sidebar_position: 2 -sidebar_label: Upgrading Unraid +sidebar_position: 1 +sidebar_label: Updating Unraid --- @@ -12,17 +12,19 @@ import UpgradeLegacy611612 from "./partials/upgrade-legacy-611-612.mdx"; import ManualDowngradeSimplest from "./partials/manual-downgrade-simplest.mdx"; import ManualDowngradeCommandLine from "./partials/manual-downgrade-command-line.mdx"; -# Upgrading Unraid +# Updating Unraid -Upgrading Unraid OS ensures that you have the latest features, security updates, and hardware support. This page outlines the standard upgrade process, along with troubleshooting tips and manual upgrade options. +Updating Unraid OS ensures that you have the latest features, security updates, and hardware support. This page outlines the standard update process, along with troubleshooting tips and manual update options. + +For help deciding between Stable, Beta, and Release Candidate (RC) builds, see [Unraid OS release types](./release-types.mdx). :::note[Prerequisites] -Before you start upgrading, make sure to create a complete backup of your boot device. For more details, refer to [Backing up your boot device](../maintain-and-update/changing-the-flash-device.mdx#backing-up-your-flash-device). +Before you start updating, make sure to create a complete backup of your boot device. For more details, refer to [Backing up your boot device](../system-administration/maintain-and-update/changing-the-flash-device.mdx#backing-up-your-flash-device). ::: -:::tip[Best practices before upgrading] +:::tip[Best practices before updating] 1. **Make a backup** of your boot device and any important data. 2. **Read the Release Notes** for the version you plan to install. @@ -33,7 +35,7 @@ Before you start upgrading, make sure to create a complete backup of your boot d ::: -## Standard upgrade process +## Standard update process @@ -47,7 +49,7 @@ Before you start upgrading, make sure to create a complete backup of your boot d :::caution[ZFS pool upgrade warnings] -When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version of ZFS. +When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version of ZFS. Upgrading your pool isn't urgent, but if you do decide to upgrade, keep in mind that it may not work with previous versions of Unraid. This means you may not be able to revert to a previous Unraid version after making the upgrade. @@ -141,7 +143,7 @@ If you don't see the option to downgrade under **Tools → Downgrade OS**, use t ### Manual downgrade or upgrade -Manual downgrades are only needed if you can't access the %%WebGUI|web-gui%% or if the downgrade option isn't available. Before proceeding, it's important to back up your boot device. For more details, see [Backing up your boot device](../maintain-and-update/changing-the-flash-device.mdx#backing-up-your-flash-device). +Manual downgrades are only needed if you can't access the %%WebGUI|web-gui%% or if the downgrade option isn't available. Before proceeding, it's important to back up your boot device. For more details, see [Backing up your boot device](../system-administration/maintain-and-update/changing-the-flash-device.mdx#backing-up-your-flash-device). diff --git a/docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-command-line.mdx b/docs/unraid-os/updating-unraid/partials/manual-downgrade-command-line.mdx similarity index 95% rename from docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-command-line.mdx rename to docs/unraid-os/updating-unraid/partials/manual-downgrade-command-line.mdx index 52eff50a9b8..3bc53388c8d 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-command-line.mdx +++ b/docs/unraid-os/updating-unraid/partials/manual-downgrade-command-line.mdx @@ -4,7 +4,7 @@ This method should only be used if you are comfortable with the Linux command li ::: -1. Copy the URL of the desired Unraid version ZIP file from the [Version History](../../../download_list.mdx). +1. Copy the URL of the desired Unraid version ZIP file from the [Version History](../../download_list.mdx). 2. Log in via %%SSH|ssh%% or console. 3. Execute the following commands *one at a time* (replace `` with the copied link): diff --git a/docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-simplest.mdx b/docs/unraid-os/updating-unraid/partials/manual-downgrade-simplest.mdx similarity index 94% rename from docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-simplest.mdx rename to docs/unraid-os/updating-unraid/partials/manual-downgrade-simplest.mdx index 143111e1535..ebb0e1ca3fd 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/partials/manual-downgrade-simplest.mdx +++ b/docs/unraid-os/updating-unraid/partials/manual-downgrade-simplest.mdx @@ -1,4 +1,4 @@ -1. Download the Unraid version ZIP file from the [Version History](../../../download_list.mdx). +1. Download the Unraid version ZIP file from the [Version History](../../download_list.mdx). 2. Unzip the file on your computer. 3. Access the `flash` network share (your boot volume; the share name may still be `flash` even when the UI says **Boot device**) or connect the USB boot device to your computer. 4. Create a `previous` directory if it doesn't already exist. diff --git a/docs/unraid-os/system-administration/maintain-and-update/partials/upgrade-legacy-611-612.mdx b/docs/unraid-os/updating-unraid/partials/upgrade-legacy-611-612.mdx similarity index 100% rename from docs/unraid-os/system-administration/maintain-and-update/partials/upgrade-legacy-611-612.mdx rename to docs/unraid-os/updating-unraid/partials/upgrade-legacy-611-612.mdx diff --git a/docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx b/docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx new file mode 100644 index 00000000000..9c56e861353 --- /dev/null +++ b/docs/unraid-os/updating-unraid/partials/upgrade-modern.mdx @@ -0,0 +1,13 @@ +Updating Unraid is done using the new **Update OS tool** with a user-friendly interface: + +1. In the %%WebGUI|web-gui%%, click the top-right dropdown menu and select **Check for Update** or navigate to ***Tools → Update OS***. +2. Review the update shown for your server's current release branch. +3. Click **View Changelog to Start Update**. The Changelog will appear for you to review before hitting **Continue**. +4. Click **Confirm and start update** to apply the selected release. +5. When prompted, reboot your server to complete the upgrade. + +:::note + +To change between the **Stable** and **Next** release branches, open the top-right account menu and choose **Manage Unraid.net Account**. Release branches are managed in the Unraid account app, not directly in the OS. + +::: diff --git a/docs/unraid-os/updating-unraid/release-types.mdx b/docs/unraid-os/updating-unraid/release-types.mdx new file mode 100644 index 00000000000..86e2023b691 --- /dev/null +++ b/docs/unraid-os/updating-unraid/release-types.mdx @@ -0,0 +1,113 @@ +--- +sidebar_position: 2 +sidebar_label: Release types +--- + +# Unraid OS release types + +Unraid OS releases are published at different levels of readiness. Understanding the difference helps you decide whether to update a production server, test a future release, or wait for a later build. + +For most servers, use the latest **Stable** release. Use **Beta** or **Release Candidate (RC)** releases only when you are comfortable testing pre-release software and reading release notes carefully. + +## Release types at a glance + +| Release type | Example version | Best for | What to expect | +| --- | --- | --- | --- | +| **Stable** | `7.2.0`, then `7.2.1`, `7.2.2`, and later patches | Production servers | General availability release recommended for normal use. A stable series often begins with a `.0` minor release, then receives patch releases with fixes and compatibility updates. | +| **Release Candidate (RC)** | `7.3.0-rc.1` | Final validation on test systems | A pre-release that is expected to be close to stable, but may still include unresolved issues or last-minute changes. | +| **Beta** | `7.3.0-beta.2` | Early testing and feedback | A pre-release used to test new features, platform changes, fixes, and upgrade paths before the release is ready for stable use. | +| **Withdrawn pre-release** | Varies | Moving off an unavailable test build | A beta or RC that is no longer enabled for regular use. Update to the latest stable release unless the release notes say otherwise. | + +## Stable releases + +A stable release is the version most users should install. Stable releases are intended for regular use and are the safest choice for servers that store important data, host services, or need predictable uptime. + +Stable release notes explain major changes, upgrade warnings, known issues, and rollback notes. Before updating, read the release notes for the version you plan to install, then follow the [standard update process](./index.mdx). + +Stable releases can include: + +- **Minor releases**, such as `7.2.0`, which start a new stable series. +- **Patch releases**, such as `7.2.5`, which update an existing stable series. + +At Unraid, minor releases usually contain the larger stable changes for a series. These can include new or changed WebGUI behavior, storage, Docker, VM, networking, security, driver, kernel, and package updates, plus upgrade-path changes that need broader validation before the stable release is published. + +After a typical `.0` stable release, later patch releases in the same series may follow. For example, `7.2.1`, `7.2.2`, and `7.2.5` are all patch releases in the `7.2` series. Patch releases are still stable releases, but they usually focus on resolving defects, addressing security issues, improving hardware or plugin compatibility, updating bundled components, and backporting important fixes without starting a new feature series. + +## Beta releases + +Beta releases are public pre-releases for users who want to help test upcoming Unraid OS changes. They can include new features, larger platform changes, dependency updates, and fixes that need broader hardware and workflow coverage before stable release. + +Install beta releases only on test or non-production systems where you can tolerate downtime, rollback work, and troubleshooting. A beta can contain regressions that are not present in the current stable release. + +Before installing a beta: + +- Back up your boot device. +- Read the full release notes, especially known issues and rollback notes. +- Confirm that your plugins and critical containers are compatible. +- Be prepared to report issues with diagnostics and reproduction steps. +- Avoid making irreversible storage or pool-format changes unless the release notes say the rollback path is safe. + +## Release candidate releases + +A release candidate is a pre-release that is closer to the intended stable version than a beta. RC builds are used to validate final fixes, packaging, upgrade behavior, and regressions before stable release. + +An RC is still pre-release software. Treat it with the same caution as a beta unless the release notes for that specific version say otherwise. + +RC releases are useful when: + +- You want to test whether a beta issue is fixed before stable release. +- You rely on hardware or plugins that need validation against the next stable version. +- You can provide useful feedback if something breaks. + +## Release branches and the Update OS tool + +In the WebGUI, open ***Tools -> Update OS*** or use **Check for Update** from the top-right menu. + +The Update OS tool shows updates for the release branch your server is already using. To change release branches, open the top-right account menu and choose **Manage Unraid.net Account** to manage the server in the [Unraid account app](../../unraid-account/server-management.mdx). You cannot switch release branches directly from inside the OS. + +- Use the **Stable** branch for stable releases. +- Use the **Next** branch for available beta and RC releases. + +The available branches and releases can change over time. If a pre-release is available on your selected branch, review the pre-release disclaimer, changelog, and release notes before continuing. + +## License and update eligibility + +Your license remains valid even if your update eligibility expires. Update eligibility only affects access to new OS updates. + +For pre-releases: + +- Beta and RC versions are for testing and may contain bugs. +- Support for a pre-release ends when the corresponding stable version is released. +- Your license must be eligible for OS updates on the stable release date to receive that stable version. +- If your update eligibility expires before the stable release, you must extend your license to upgrade to that stable version or roll back to a supported stable version that your license allows. + +For more detail, see [What happens with pre-releases](../troubleshooting/licensing-faq.mdx#pre-release-policy) in the licensing FAQ. + +## Choosing the right release + +Use this general rule: + +- Use **Stable** for production systems, important data, remote servers, and systems you do not want to troubleshoot. +- Use **RC** when you want to validate the next stable release and can handle pre-release risk. +- Use **Beta** when you want early access to new work and are prepared to test, report issues, and potentially roll back. +- Do not remain on old beta or RC releases. When a newer pre-release or stable release is available, update or roll back to a supported stable version. + +If you are unsure, stay on the latest stable release. + +## Reporting issues and feature requests + +Good feedback helps turn beta and RC builds into better stable releases and helps improve stable releases over time. When reporting an issue, include: + +- The exact Unraid OS version. +- Whether the issue started after upgrading. +- Diagnostics from ***Tools -> Diagnostics***. +- Steps to reproduce the issue. +- Any relevant plugin, Docker, VM, network, or storage configuration details. + +Use the relevant Product Unraid tracker: + +- For stable release bugs, use [Unraid OS Bug Reports](https://product.unraid.net/b/unraid-os-bugs). +- For beta or RC feedback, use [Unraid OS Pre-release (Bugs & Feedback)](https://product.unraid.net/b/unraid-os-prerelease-bugs-feedback). +- For product ideas and enhancements, use [Unraid OS Feature Requests](https://product.unraid.net/b/unraid-os-feature-requests). + +For stable release discussions and announcements, see the [Unraid announcements forum](https://forums.unraid.net/forum/7-announcements/). diff --git a/docs/unraid-os/using-unraid-to/_category_.json b/docs/unraid-os/using-unraid-to/_category_.json index b7725209325..40737c43165 100644 --- a/docs/unraid-os/using-unraid-to/_category_.json +++ b/docs/unraid-os/using-unraid-to/_category_.json @@ -4,4 +4,4 @@ "link": { "type": "generated-index" } - } \ No newline at end of file + } diff --git a/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx b/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx index 8725f9d4a3e..d5a10446621 100644 --- a/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx +++ b/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx @@ -106,7 +106,7 @@ The **Action Center** is located within the **Apps** tab in the %%WebGUI|web-gui - **Incompatible applications**: Applications that may not work with your current Unraid version - **Blacklisted applications**: Applications that have been removed from the catalog for security or compatibility reasons -When you access the Action Center, you'll see alerts for any applications requiring attention. To update an application, click on Actions for the app that needs updating, and then select **Update** to run the update script. Regular updates are essential for maintaining the security, stability, and compatibility of your Unraid installation. See [Upgrading Unraid](../../system-administration/maintain-and-update/upgrading-unraid.mdx) for more information. +When you access the Action Center, you'll see alerts for any applications requiring attention. To update an application, click on Actions for the app that needs updating, and then select **Update** to run the update script. Regular updates are essential for maintaining the security, stability, and compatibility of your Unraid installation. See [Updating Unraid](../../updating-unraid/index.mdx) for more information. --- diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 39f7ad70c7e..e5cbb9fc963 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -242,6 +242,10 @@ const config: Config = { items: [ { label: "Forums", href: "https://forums.unraid.net" }, { label: "Discord", href: "https://discord.unraid.net/" }, + { + label: "Feature and Bug Tracker", + href: "https://product.unraid.net/", + }, ], }, { @@ -345,6 +349,22 @@ const config: Config = { from: "/category/zfs/", to: "/unraid-os/advanced-configurations/optimize-storage/zfs-storage/", }, + { + from: "/unraid-os/system-administration/maintain-and-update/", + to: "/unraid-os/updating-unraid/", + }, + { + from: "/unraid-os/system-administration/maintain-and-update/release-types/", + to: "/unraid-os/updating-unraid/release-types/", + }, + { + from: "/unraid-os/system-administration/maintain-and-update/upgrading-unraid/", + to: "/unraid-os/updating-unraid/", + }, + { + from: "/unraid-os/updating-unraid/upgrading-unraid/", + to: "/unraid-os/updating-unraid/", + }, // Connect redirects { from: "/connect/", to: "/unraid-connect/overview-and-setup/" }, @@ -616,7 +636,7 @@ const config: Config = { { from: "/unraid-os/manual/tools/", to: "/category/advanced-tools/" }, { from: "/unraid-os/manual/upgrade-instructions/", - to: "/unraid-os/system-administration/maintain-and-update/upgrading-unraid/", + to: "/unraid-os/updating-unraid/", }, { from: "/unraid-os/manual/users/", @@ -980,7 +1000,7 @@ const config: Config = { { from: "/go/troubleshooting/", to: "/unraid-os/troubleshooting/" }, { from: "/go/upgrade-instructions/", - to: "/unraid-os/system-administration/maintain-and-update/upgrading-unraid/", + to: "/unraid-os/updating-unraid/", }, { from: "/go/upgrading-a-vm-to-windows-11/", diff --git a/sidebar-semver-sort.js b/sidebar-semver-sort.js index 44f07e538bb..e6a8c80ab05 100644 --- a/sidebar-semver-sort.js +++ b/sidebar-semver-sort.js @@ -20,10 +20,61 @@ function addItemTitle(item) { }; } +function itemLabel(item) { + return item.label?.toLowerCase(); +} + +function isVersionHistoryDoc(item) { + return item.type === "doc" && item.id === "unraid-os/download_list"; +} + +function groupReleaseReferencesUnderUpdatingUnraid(items) { + const updatingIndex = items.findIndex((item) => + item.type === "category" && itemLabel(item) === "updating unraid" + ); + + if (updatingIndex === -1) { + return items; + } + + const releaseNotes = []; + const versionHistory = []; + const remainingItems = []; + + items.forEach((item, index) => { + if (index === updatingIndex) { + remainingItems.push(item); + } else if (item.type === "category" && itemLabel(item) === "release notes") { + releaseNotes.push(item); + } else if (isVersionHistoryDoc(item)) { + versionHistory.push(item); + } else { + remainingItems.push(item); + } + }); + + if (releaseNotes.length === 0 && versionHistory.length === 0) { + return items; + } + + const updatedUpdatingCategory = { + ...items[updatingIndex], + items: [ + ...(items[updatingIndex].items || []), + ...releaseNotes, + ...versionHistory, + ], + }; + + return remainingItems.map((item) => + item === items[updatingIndex] ? updatedUpdatingCategory : item + ); +} + function sortSidebarItems(items, sortBySemver = false) { - const result = items.map((item) => { + let result = items.map((item) => { if (item.type === "category") { - if (item.label.toLowerCase() === "release notes") { + if (itemLabel(item) === "release notes") { return { ...item, items: sortSidebarItems(item.items, true) }; } else { return { ...item, items: sortSidebarItems(item.items, false) }; @@ -32,6 +83,10 @@ function sortSidebarItems(items, sortBySemver = false) { return item; }); + if (!sortBySemver) { + result = groupReleaseReferencesUnderUpdatingUnraid(result); + } + if (sortBySemver) { const subfolderArrays = result.reduce((acc, item) => { const semverCompare = getSemverFromId(item.id);