Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand All @@ -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" }}>
![Set root password](/img/Set_root_password.png)
</div>

Expand All @@ -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.

:::
Comment on lines +53 to +57
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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
Verify each finding against the current code and only fix it if needed.

In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`
around lines 53 - 57, The callout header text is inconsistent with the body;
update the note tag label from "Unraid 7.3 only" to match the body wording
(e.g., "Unraid 7.3 and later") by changing :::note[Unraid 7.3 only] to
:::note[Unraid 7.3 and later] so the callout and the sentence "The onboarding
wizard below applies to Unraid 7.3 and later." are consistent.


1. Press **Get Started** to launch the onboarding wizard. If you prefer to configure manually, select **Skip Setup**.

<div style={{ margin: "auto", maxWidth: "500px" }}>
![Step 1: Welcome to Unraid](/img/onboarding_step1.png)
</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" }}>
![Step 2: Configure Settings](/img/onboarding_step2.png)
</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" }}>
![Step 3: Flash Boot](/img/onboarding_step3a.png)
</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" }}>
![Step 3: Internal Boot](/img/onboarding_step3b.png)
</div>

4. Optionally choose whether to preinstall key plugins, then click **Next**.

<div style={{ margin: "auto", maxWidth: "500px" }}>
![Step 4: Plugins](/img/onboarding_step4.png)
</div>

5. Review the summary, then click **Confirm & Apply**.

<div style={{ margin: "auto", maxWidth: "500px" }}>
![Step 5: Summary](/img/onboarding_step5.png)
</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" }}>
![Step 6: Next Steps](/img/onboarding_step6.png)
</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" }}>
![Get started](/img/Upc_get_started.png)
</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" }}>
![Install trial key](/img/Upc_install_trial_key.png)
</div>

This process allows you to manage your Unraid OS license keys, obtain new keys, recover lost ones, or upgrade your license.

:::important

For details on your license, visit ***ToolsRegistration*** in the %%WebGUI|web-gui%%.
For details on your license, visit **_ToolsRegistration_** in the %%WebGUI|web-gui%%.

:::

Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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
Verify each finding against the current code and only fix it if needed.

In
`@docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx`
around lines 142 - 159, Normalize the leading spaces for all checklist lines so
indentation is consistent: remove the extra leading spaces before "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", the Advanced Settings items such as "Enable
**%%hardware virtualization|hvm%%** features" and "Enable **%%IOMMU|iommu%%**
support", and the Troubleshooting Tips lines like "Adjusting the boot order to:
**Forced-FDD**, **USB-HDD**, **USB-ZIP**", ensuring every checklist line uses
the same leading whitespace (either none or one space) so rendered indentation
is uniform.


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>
Binary file added static/img/onboarding_step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step3a.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step3b.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/onboarding_step6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.