docs(installer): add Unraid Installer setup guide - #529
Conversation
- Purpose: document the public Unraid Installer workflow in the main Unraid documentation site.\n- Before: the Set up Unraid category described USB Creator and onboarding paths but did not explain the target-machine installer.\n- Problem: users installing through remote consoles, virtual machines, or internal boot lacked a dedicated guide.\n- New: add asset selection, boot instructions, menu features, flash boot and internal boot procedures, safety warnings, and troubleshooting.\n- How: add a standalone MDX page to the autogenerated Set up Unraid category.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Disabled knowledge base sources:
📝 WalkthroughWalkthroughAdded a complete Unraid Installer guide. It covers installer selection, prerequisites, assets, boot methods, flash and internal boot workflows, destructive-disk warnings, troubleshooting, and follow-up resources. ChangesUnraid Installer Documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | 6cb854e | Commit Preview URL Branch Preview URL |
Aug 25 2026, 07:42 PM |
Summary
Add a standalone Unraid Installer guide to the Set up Unraid documentation category.
Why This Exists
The existing setup documentation explains the USB Creator and the post-boot onboarding flow, but it does not explain the target-machine Unraid Installer. Users installing through a remote console, virtual machine, Proxmox, Hetzner, or internal boot need a separate guide.
Resolution
Add a user-facing page that explains:
This page documents the installer work in bootable-unraid-installer PR #37.
Reviewer Considerations
sidebar_position: 1.5so it appears after the existing boot-media page without changing the order of the other setup pages.Behavior Changes
Adds user-facing documentation only. Product behavior is unchanged.
Implementation Summary
docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx.Verification
git diff --checkpassed.Risk
Low; documentation-only change. Review should focus on product terminology and the external release links.
Summary by CodeRabbit