DOCSEARCHbyAlgolia
Submit Docs

Unraid OS Documentation

website·Indexed 37 days ago

https://docs.unraid.net

Official documentation for Unraid OS, featuring getting started guides for installation and WebGUI configuration, system settings for CPU pinning and network management, and comprehensive release notes for versions 6.9.0 through 6.12.14.

Tokens
103K
Snippets
210
Records
878
Agent score
69%

What's inside Unraid

  1. Overview of Unraid Connect Remote Access

    Unraid Connect Remote Access publishes the Unraid WebGUI to the internet via UPnP or manual port forwarding. This is distinct from the Unraid Connect dashboard, which uses a server-initiated connection and does not expose the WebGUI. For remote management without exposing the WebGUI to WAN traffic, the official Tailscale integration or a VPN Tunnel is recommended.

  2. Overview of the Unraid WebGUI Navigation Bar

    The Unraid WebGUI is the primary interface for managing the server. The horizontal navigation bar provides access to the following functional areas:

    • Dashboard: Real-time monitoring of hardware (CPU, RAM, storage, network) and software (Containers, VMs, users, shares) via a grid of tiles.
    • Main: Management of storage and disk operations, including the array, cache pools, boot devices, USB storage, and unassigned devices.
    • Shares: Management of User Shares and Disk Shares.
    • Users: Management of all user accounts on the server.
    • Settings: Configuration for System Settings, Network Services (including Wireguard VPN), User Preferences, and User Utilities.
    • Plugins: List of installed plugins. New plugins can be added via the Apps (Community Applications) section.
    • Docker: Management of installed containers, including launching, stopping, and configuring auto-start settings.
    • VMs: Management of virtual machines, including CPU assignments, vDisk allocation, and graphics settings. (Note: This tab only appears if hardware virtualization requirements are met).
    • Apps (Community Applications): The official source for community-sourced plugins and Docker containers.
    • Tools: System management tools, WebGUI customization, and system updates.

  3. Overview of Unraid Cache Pools

    A cache pool in Unraid is a collection of one or more drives (typically SSDs or high-speed HDDs) used to temporarily store data before it is moved to the main array via the Mover. Cache pools are primarily used to increase write speeds, provide redundancy for cached files (via RAID 1 in multi-device mode), and optimize performance for Docker containers and virtual machines.

  4. Overview of Unraid WebGUI management features

    Unraid is managed via a web interface (WebGUI) that provides a balance of simplified default settings for common tasks and advanced tuning for experienced users. Key management capabilities include:

    • System Monitoring: A Dashboard view for real-time disk health, temperatures, resource utilization, and application states.
    • Storage & Array Management: Tools to assign devices to the array or cache, control disk spin, start/stop the array, and perform parity checks.
    • Share Management: Creation of network shares with configurable access and distribution policies.
    • Hardware Tuning: Disk spin-down controls, file system format selection, and power consumption optimization.
    • Network Configuration: Support for NIC bonding, bridging, and time server configuration.
    • System Maintenance: A Task Scheduler for automatic parity checks and Mover script execution (transferring files from cache to array).
    • System Safety & Alerts: APC UPS integration for safe shutdowns during power loss and a notification system for alerts via the console or email.
    • Application Hosting: Management of Docker containers using community templates and the ability to deploy pre-created or custom Virtual Machines (VMs).

  5. Overview of Unraid Community Applications

    Community Applications (CA) is a curated catalog of over 2,000 free Docker containers and plugins maintained by the Unraid community. It adds an Apps tab to the Unraid WebGUI, providing a store-like interface to browse, search, and filter applications.

    Key application labels include:

    • Beta: Active development; may contain bugs.
    • Installed: Currently present on the server.
    • Updated: A newer version is available.
    • Monthly CA Spotlight: Featured for quality or popularity.

  6. Manage ZFS pools when upgrading to Unraid 7.0

    When upgrading from Unraid 6.12 to 7.0, users will see a warning about unsupported features in existing ZFS pools because 7.0 uses a newer ZFS version. This warning is harmless and the pool will function normally. While an upgrade button is provided to support new ZFS features, doing so prevents previous Unraid OS versions from mounting the pool. Additionally, new pools created in 7.0 cannot be mounted in 6.12 as ZFS does not support downgrades. ZFS spares are not supported in 7.0; remove any 'spares' vdev from hybrid pools created in 6.12 before upgrading.

  7. Access the built-in Unraid API

    The Unraid API is now integrated directly into the OS. It is fully open source and is being used to power the new Notifications panel and future webGUI updates.
    API Source: https://github.com/unraid/api

  8. Understand Unraid Array and Cache Pools

    Unraid utilizes two primary storage structures:

    • Array: The main collection of data disks, which can include parity protection for data redundancy.
    • Cache Pool: High-speed storage (typically SSDs) used to temporarily store newly written data before the 'Mover' process transfers it to the array. Pools can be single-disk or multi-disk.

  10. Determine when to use WireGuard vs Tailscale on Unraid

    WireGuard is a robust built-in VPN solution for Unraid, preferred over Tailscale in advanced networking scenarios. Choose WireGuard if you require:

    • Custom VPN tunnel setups and integration with existing network infrastructure.
    • Persistent encrypted server-to-server links between Unraid servers.
    • LAN-to-LAN integration without third-party intermediary services.
    • Maximum throughput for bandwidth-intensive tasks due to minimal protocol overhead.

    For most users, Tailscale is recommended as it typically does not require manual port forwarding or complex configuration.

  11. Understand Unraid OS license ownership and updates

    Unraid OS uses a perpetual license model. When you purchase a license, you own that version of the software forever.

    • Starter and Unleashed: Include one year of updates. After one year, an optional $36 USD annual extension fee is required to receive new major updates.
    • Lifetime: Includes updates for the life of the product.
    • If updates lapse: You can continue using your current version indefinitely. You will still receive patch updates for your current minor version (e.g., 7.1.x) as long as that minor version is still supported by Lime Technology. Once a minor version reaches end-of-life (EOL), you must extend your license to receive further security patches or bug fixes.

  12. Unraid OS 7.3.2 Release Overview

    Unraid OS 7.3.2 is a security and bugfix release recommended for all users. Key updates include:

    • Linux kernel 6.18.38
    • Unraid API 4.35.1
    • Docker VLAN networking fixes
    • Storage and boot-pool fixes
    • Virtualization UI improvements
    • Security fix for WebGUI update.php path-traversal command execution (CVE-2026-3838)