-
Notifications
You must be signed in to change notification settings - Fork 48
docs: add Unraid 7.3 onboarding wizard flow #414
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
Open
ljm42
wants to merge
2
commits into
main
Choose a base branch
from
feature/internal-boot
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ After booting Unraid OS for the first time, you'll use the %%WebGUI|web-gui%% to | |
|
|
||
| :::info[Localize] | ||
|
|
||
| It may be easier for users to follow this guide after configuring their language settings. Check out [Multi-language support](../../using-unraid-to/customize-your-experience/multi-language-support.mdx) to make the %%WebGUI|web-gui%% more accessible in your preferred language. | ||
| It may be easier for users to follow this guide after configuring their language settings. Check out [Multi-language support](../../using-unraid-to/customize-your-experience/multi-language-support.mdx) to make the %%WebGUI|web-gui%% more accessible in your preferred language. | ||
|
|
||
| ::: | ||
|
|
||
|
|
@@ -33,12 +33,12 @@ When you access the %%WebGUI|web-gui%% for the first time, you'll be prompted to | |
| Make sure your password is: | ||
|
|
||
| - Unique | ||
| - At least 8 characters long. (Although, best practice recommends 12+ for the most secure passwords!) | ||
| - At least 8 characters long. (Although, best practice recommends 12+ for the most secure passwords!) | ||
| - A mix of letters, numbers, and special characters | ||
|
|
||
| We recommend using a password manager for secure storage. | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '300px'}}> | ||
| <div style={{ margin: "auto", maxWidth: "300px" }}> | ||
|  | ||
| </div> | ||
|
|
||
|
|
@@ -48,27 +48,83 @@ If you forget your root password, you can reset it following the [Reset your pas | |
|
|
||
| ::: | ||
|
|
||
| ## Onboarding | ||
|
|
||
| :::note[Unraid 7.3 only] | ||
|
|
||
| The onboarding wizard below applies to Unraid 7.3 and later. | ||
|
|
||
| ::: | ||
|
|
||
| 1. Press **Get Started** to launch the onboarding wizard. If you prefer to configure manually, select **Skip Setup**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| To relaunch the wizard later, go to **_Settings → Onboarding Wizard_**. | ||
|
|
||
| 2. Configure your server settings, including server name and description, time zone, language, and optional SSH/theme preferences. Then click **Next**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| 3. Choose your boot option: | ||
| - For **flash boot**, keep the default USB/flash boot configuration and click **Next**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
| - For **internal boot**, choose single or mirrored boot mode, select the | ||
| device(s), and set the space reserved for the boot partition. Then click | ||
| **Next**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| 4. Optionally choose whether to preinstall key plugins, then click **Next**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| 5. Review the summary, then click **Confirm & Apply**. | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| 6. On the **Next Steps** screen, review the recommended follow-up actions, then click: | ||
| - **Go to Dashboard** if you chose flash boot | ||
| - **Reboot** if you chose internal boot | ||
|
|
||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| ## Register your license key | ||
|
|
||
| After setting your root password, log in to your Unraid.net account to obtain a license key: | ||
| Log in to your Unraid.net account to obtain a license key: | ||
|
|
||
| 1. In the %%WebGUI|web-gui%%, go to the **Get Started** section. | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '500px'}}> | ||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| 2. Sign in or create an account, after which a trial key will be installed automatically. | ||
|
|
||
| <div style={{ margin: 'auto', maxWidth: '500px'}}> | ||
| <div style={{ margin: "auto", maxWidth: "500px" }}> | ||
|  | ||
| </div> | ||
|
|
||
| This process allows you to manage your Unraid OS license keys, obtain new keys, recover lost ones, or upgrade your license. | ||
ljm42 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| :::important | ||
|
|
||
| For details on your license, visit ***Tools → Registration*** in the %%WebGUI|web-gui%%. | ||
| For details on your license, visit **_Tools → Registration_** in the %%WebGUI|web-gui%%. | ||
|
|
||
| ::: | ||
|
|
||
|
|
@@ -79,35 +135,35 @@ Before deploying Unraid OS, it's important to verify your system's BIOS and stor | |
| <details> | ||
| <summary>Click to expand our BIOS and Storage Controller checklist</summary> | ||
|
|
||
| Proper BIOS and storage controller configuration is vital for a stable Unraid OS deployment. Use this checklist before your first boot. | ||
| Proper BIOS and storage controller configuration is vital for a stable Unraid OS deployment. Use this checklist before your first boot. | ||
|
|
||
| ### Basic Settings | ||
| ### Basic Settings | ||
|
|
||
| ✅ Set the USB flash drive as the primary boot device.\ | ||
| ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\ | ||
| ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\ | ||
| ✅ Disable **Secure Boot** as it is not supported by Unraid OS. | ||
| ✅ Set the USB flash drive as the primary boot device.\ | ||
| ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\ | ||
| ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\ | ||
| ✅ Disable **Secure Boot** as it is not supported by Unraid OS. | ||
|
|
||
| ### Advanced Settings | ||
| ### Advanced Settings | ||
|
|
||
| ✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\ | ||
| ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs. | ||
| ✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\ | ||
| ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs. | ||
|
|
||
| ### Troubleshooting Tips | ||
| ### Troubleshooting Tips | ||
|
|
||
| If Unraid OS does not boot, try: | ||
| If Unraid OS does not boot, try: | ||
|
|
||
| ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\ | ||
| ✅ Disabling USB 2.0/3.0 support.\ | ||
| ✅ Toggling any Fast Boot features.\ | ||
| ✅ Toggling USB keyboard support. | ||
| ✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\ | ||
| ✅ Disabling USB 2.0/3.0 support.\ | ||
| ✅ Toggling any Fast Boot features.\ | ||
| ✅ Toggling USB keyboard support. | ||
|
Comment on lines
+142
to
+159
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Inconsistent leading spaces in checklist items. Some checkmark items have a leading space (lines 143-145, 150, 157-159) while others don't (lines 142, 149, 154, 156). This creates inconsistent indentation in the rendered output. ✅ Set the USB flash drive as the primary boot device.\
- ✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\
- ✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\
- ✅ Disable **Secure Boot** as it is not supported by Unraid OS.
+✅ Configure the storage controller to **%%AHCI|ahci%%** mode with SATA connections.\
+✅ Set the controller to **%%HBA mode|hba-mode%%** (not **%%RAID|raid%%**).\
+✅ Disable **Secure Boot** as it is not supported by Unraid OS.
### Advanced Settings
✅ Enable **%%hardware virtualization|hvm%%** features (e.g., **%%Intel VT-x|intel-vt-x%%** or **%%AMD-V|amd-v%%**) for **%%virtual machines (VMs)|vm%%**.\
- ✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs.
+✅ Enable **%%IOMMU|iommu%%** support (Intel VT-d or AMD-Vi) for PCI device assignment to VMs.
### Troubleshooting Tips
If Unraid OS does not boot, try:
✅ Adjusting the boot order to: **Forced-FDD**, **USB-HDD**, **USB-ZIP**.\
- ✅ Disabling USB 2.0/3.0 support.\
- ✅ Toggling any Fast Boot features.\
- ✅ Toggling USB keyboard support.
+✅ Disabling USB 2.0/3.0 support.\
+✅ Toggling any Fast Boot features.\
+✅ Toggling USB keyboard support.🤖 Prompt for AI Agents |
||
|
|
||
| For further assistance, visit the [Unraid general support forum](https://forums.unraid.net/). | ||
| For further assistance, visit the [Unraid general support forum](https://forums.unraid.net/). | ||
|
|
||
| :::important | ||
| Many motherboards limit boot device selection to 12 hard drives. If your USB flash drive is recognized as a hard drive, you may not be able to boot from it after installing 12 physical hard drives. Configure the BIOS to treat the flash drive as a removable device whenever possible. | ||
| :::important | ||
| Many motherboards limit boot device selection to 12 hard drives. If your USB flash drive is recognized as a hard drive, you may not be able to boot from it after installing 12 physical hard drives. Configure the BIOS to treat the flash drive as a removable device whenever possible. | ||
|
|
||
| If using an add-on HBA, you may be able to disable INT 13h support to prevent its connected drives from appearing in the bootable devices list, helping to stay within the 12-drive limit. | ||
| ::: | ||
| If using an add-on HBA, you may be able to disable INT 13h support to prevent its connected drives from appearing in the bootable devices list, helping to stay within the 12-drive limit. | ||
| ::: | ||
|
|
||
| </details> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make the version callout consistent.
Line 53 says “Unraid 7.3 only”, but Line 55 says the wizard applies to “7.3 and later.” Those scopes conflict; please rename the note to match the broader wording.
🤖 Prompt for AI Agents