diff --git a/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx b/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx index 7a8e10d7c10..1d768fe7223 100644 --- a/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx +++ b/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx @@ -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. -
+
![Set root password](/img/Set_root_password.png)
@@ -48,19 +48,75 @@ 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**. + +
+ ![Step 1: Welcome to Unraid](/img/onboarding_step1.png) +
+ + 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**. + +
+ ![Step 2: Configure Settings](/img/onboarding_step2.png) +
+ +3. Choose your boot option: + - For **flash boot**, keep the default USB/flash boot configuration and click **Next**. + +
+ ![Step 3: Flash Boot](/img/onboarding_step3a.png) +
+ - 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**. + +
+ ![Step 3: Internal Boot](/img/onboarding_step3b.png) +
+ +4. Optionally choose whether to preinstall key plugins, then click **Next**. + +
+ ![Step 4: Plugins](/img/onboarding_step4.png) +
+ +5. Review the summary, then click **Confirm & Apply**. + +
+ ![Step 5: Summary](/img/onboarding_step5.png) +
+ +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 + +
+ ![Step 6: Next Steps](/img/onboarding_step6.png) +
+ ## 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. -
+
![Get started](/img/Upc_get_started.png)
2. Sign in or create an account, after which a trial key will be installed automatically. -
+
![Install trial key](/img/Upc_install_trial_key.png)
@@ -68,7 +124,7 @@ After setting your root password, log in to your Unraid.net account to obtain a :::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
Click to expand our BIOS and Storage Controller checklist - 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. - 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. +:::
diff --git a/static/img/onboarding_step1.png b/static/img/onboarding_step1.png new file mode 100644 index 00000000000..b9f34b76a65 Binary files /dev/null and b/static/img/onboarding_step1.png differ diff --git a/static/img/onboarding_step2.png b/static/img/onboarding_step2.png new file mode 100644 index 00000000000..b52442181e1 Binary files /dev/null and b/static/img/onboarding_step2.png differ diff --git a/static/img/onboarding_step3a.png b/static/img/onboarding_step3a.png new file mode 100644 index 00000000000..65f7e3d85b2 Binary files /dev/null and b/static/img/onboarding_step3a.png differ diff --git a/static/img/onboarding_step3b.png b/static/img/onboarding_step3b.png new file mode 100644 index 00000000000..bc29299112d Binary files /dev/null and b/static/img/onboarding_step3b.png differ diff --git a/static/img/onboarding_step4.png b/static/img/onboarding_step4.png new file mode 100644 index 00000000000..637e10fbeed Binary files /dev/null and b/static/img/onboarding_step4.png differ diff --git a/static/img/onboarding_step5.png b/static/img/onboarding_step5.png new file mode 100644 index 00000000000..e805c0c43eb Binary files /dev/null and b/static/img/onboarding_step5.png differ diff --git a/static/img/onboarding_step6.png b/static/img/onboarding_step6.png new file mode 100644 index 00000000000..00e60be6418 Binary files /dev/null and b/static/img/onboarding_step6.png differ