Skip to content

docs(installer): add Unraid Installer setup guide - #529

Merged
Eli Bosley (elibosley) merged 1 commit into
mainfrom
codex/unraid-installer-guide
Aug 26, 2026
Merged

docs(installer): add Unraid Installer setup guide#529
Eli Bosley (elibosley) merged 1 commit into
mainfrom
codex/unraid-installer-guide

Conversation

@elibosley

@elibosley Eli Bosley (elibosley) commented Aug 25, 2026

Copy link
Copy Markdown
Member

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:

  • When to use Unraid Installer instead of Unraid USB Creator.
  • Online ISO, online IMG, and bundled IMG release assets.
  • Booting through virtual media or a USB device.
  • Installer menu features and network recovery.
  • Flash Boot and Internal Boot workflows, including mirrored boot devices.
  • Disk-erasure warnings and common troubleshooting steps.

This page documents the installer work in bootable-unraid-installer PR #37.

Reviewer Considerations

  • Confirm the product wording for online versus bundled installer assets.
  • Confirm that the target-machine, remote-console, and internal-boot use cases match the launch plan.
  • The new page uses sidebar_position: 1.5 so it appears after the existing boot-media page without changing the order of the other setup pages.
  • This PR does not change installer behavior or the existing USB Creator page.

Behavior Changes

Adds user-facing documentation only. Product behavior is unchanged.

Implementation Summary

  • Add docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx.
  • Let the autogenerated Set up Unraid category include the page.

Verification

  • Targeted Remark MDX lint passed.
  • Prettier check passed.
  • git diff --check passed.
  • Full Docusaurus build was not run because the repository guidance excludes full builds from routine validation.

Risk

Low; documentation-only change. Review should focus on product terminology and the external release links.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for using the Unraid Installer.
    • Covers installer selection, prerequisites, asset types, booting, menu actions, flash and internal boot workflows, disk warnings, troubleshooting, and next steps.

- 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.
@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e23ea0a3-9e67-4f73-9881-240f61b82ef9

📥 Commits

Reviewing files that changed from the base of the PR and between 346bede and 6cb854e.

📒 Files selected for processing (1)
  • docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

Added 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.

Changes

Unraid Installer Documentation

Layer / File(s) Summary
Installer scope and preparation
docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx
Defines supported environments, installer choices, prerequisites, required assets, network requirements, backups, and checksum verification.
Boot and menu operations
docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx
Documents virtual-media and USB booting, boot-menu selection, installer menu actions, text-mode fallback, and disk-erasure warnings.
Flash boot workflow
docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx
Describes release selection, target-disk confirmation, FAT32 and UNRAID creation, file copying, bootability setup, and rebooting.
Internal boot and troubleshooting
docs/unraid-os/getting-started/set-up-unraid/use-the-unraid-installer.mdx
Describes internal boot setup for one or two disks, validation, disk protections, rebooting, troubleshooting, and follow-up resources.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Poem

A rabbit reads the installer page,
With careful paws, it checks each stage.
It guards the disks from careless art,
Then boots Unraid with a hop and start.
Clear steps guide the way ahead,
While carrots wait beside the shed.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/unraid-installer-guide

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

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

@elibosley
Eli Bosley (elibosley) marked this pull request as ready for review August 26, 2026 01:12
@elibosley
Eli Bosley (elibosley) merged commit fdea1d1 into main Aug 26, 2026
4 of 5 checks passed
@elibosley
Eli Bosley (elibosley) deleted the codex/unraid-installer-guide branch August 26, 2026 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant