Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
45ee720
docs: enhance documentation with comprehensive content expansions and…
Oct 14, 2025
4bb42ed
Merge branch 'main' of https://github.com/unraid/docs
Oct 14, 2025
ba26e71
Merge branch 'main' of https://github.com/unraid/docs
Oct 14, 2025
55a491e
docs: apply CodeRabbit formatting and clarity improvements
Oct 15, 2025
f09af34
docs: fix VM snapshot memory dump guidance (CodeRabbit)
Oct 15, 2025
8c00d78
Merge remote-tracking branch 'upstream/main'
Oct 15, 2025
c5d59fe
docs: Fix VM paths, icon organization, and rebuild instructions
Oct 24, 2025
d8ce64c
docs: Organize notification agent icons in dedicated static directory
Oct 24, 2025
b35b7ac
Merge remote-tracking branch 'upstream/main'
Oct 28, 2025
41581ba
docs: Flatten tabbed content and improve documentation accessibility
Oct 31, 2025
9c55e3f
refactor: update sidebar sorting and improve documentation clarity
Oct 31, 2025
393e605
fix: update iframe attributes to JSX camelCase format
Oct 31, 2025
52f84c7
Merge upstream/main: resolve conflicts in release notes and documenta…
Oct 31, 2025
914b829
Merge upstream/main: sync with 7.2.0 release notes update
Oct 31, 2025
28bf859
docs: Update FAQ structure and table of contents settings
Oct 31, 2025
122f77d
docs: Update FAQ and Licensing FAQ for improved structure and accessi…
Oct 31, 2025
3a63f3a
Merge branch 'main' of https://github.com/grizzlechips/docs
Oct 31, 2025
ccb57e8
Merge upstream/main: Bring in Unraid Account section and latest changes
Nov 4, 2025
d582a4b
chore: update documentation for API and configuration improvements
Nov 7, 2025
5e539e5
fix: update documentation and image paths for ZFS storage
Nov 7, 2025
47b247f
fix: update image paths in ZFS storage documentation
Nov 7, 2025
9f89784
fix: update release notes for Unraid OS 7.2.0
Nov 7, 2025
3f0fc6b
fix: update Docusaurus configuration and release notes formatting
Nov 7, 2025
62f14f5
Merge branch 'main' into main
ljm42 Nov 8, 2025
fd459fa
Update documentation for Unraid OS settings and features
Dec 20, 2025
a72fcac
Update ZFS storage documentation image reference
Dec 20, 2025
0a56ce3
Update documentation and configuration files
Jan 8, 2026
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
2 changes: 2 additions & 0 deletions docs/API/how-to-use-the-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ The Apollo GraphQL Studio provides a comprehensive view of all available queries

:::

### WebGUI method (recommended)

Using the %%WebGUI|web-gui%% is the easiest way to enable the %%GraphQL|graphql%% sandbox:

1. Navigate to ***Settings → Management Access → Developer Options***
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ If you're running a traditional Unraid %%array|array%% and want to add %%ZFS|zfs

- **Drive size mismatch in RAIDZ:** %%ZFS|zfs%% treats all disks in a RAIDZ vdev as the size of the smallest one. To ensure the best efficiency, always use identically sized drives within each vdev.

- **Expanding RAIDZ vdevs via the %%WebGUI|web-gui%%:** RAIDZ expansion is available via the %%WebGUI|web-gui%% in Unraid 7.2 and later. Earlier versions (7.1.x) supported expansion via CLI only.
- **Expanding RAIDZ vdevs via the %%WebGUI|web-gui%%:** RAIDZ expansion is available via the %%WebGUI|web-gui%% in Unraid 7.2 and later. Earlier versions (7.1.x) supported expansion via CLI only. For step-by-step instructions, see [RAIDZ expansion](../../using-unraid-to/manage-storage/cache-pools.mdx#raidz-expansion).

- **%%ZFS|zfs%% disk vs. full zpool:** A single %%ZFS|zfs%%-formatted disk in the Unraid %%array|array%% does not offer the redundancy or features of a dedicated %%ZFS|zfs%% pool. To leverage advanced functionality, use standalone pools.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ Unraid OS automatically functions but allows further customization of settings s

Don't forget - the %%WebGUI|web-gui%% includes built-in help. To access help for a specific field, click the prompt next to it, or use the **Help** icon ![Help icon](/img/helpicon.png) at the top right of the interface to toggle help for all fields.

## System Settings
## System settings

**System Settings** enable you to configure key functionalities like network, share, %%VM|vm%%, and disk settings.

### CPU Pinning
### CPU pinning

%%CPU Pinning|cpu-pinning%% allows you to assign specific CPU cores to %%VMs|vm%% (Virtual Machines) or Docker containers. This is particularly important for performance-sensitive workloads, such as gaming %%VMs|vm%%. Even if you manually assign Docker containers to avoid conflicts with your gaming %%VM|vm%%, the host operating system may still utilize those cores for tasks like managing the %%WebGUI|web-gui%%, running a %%parity check|parity-check%%, or performing %%BTRFS|btrfs%% operations.

- When you pin a core to a %%VM|vm%% or Docker container, that core is allocated to the %%VM|vm%% or container. However, Unraid OS may still access it for routine tasks.
- When you isolate a core, it becomes dedicated to the %%VM|vm%% or container and is no longer accessible to Unraid OS.
- You can pin cores without needing to restart your server, but applying CPU isolation changes does require a system restart.

### Date & Time
### Date & time

On this page, you can set your time zone and toggle the use of up to four NTP servers. You should adjust Unraid to match your time zone for accurate timekeeping.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Toolbar - Settings](/img/date-time.png)
</div>

### Disk Settings
### Disk settings

You can modify additional settings for your disk devices on this page. Enable your %%array|array%% to start automatically on boot, adjust disk %%spin-down timers|spin-down-timers%%, and even change advanced driver settings like %%SMART polling frequency|smart-polling%%.

Expand Down Expand Up @@ -69,23 +69,105 @@ Unraid defaults to the hostname `tower`, but you can change it here. You can als
![Settings - Identification](/img/settings-identification.png)
</div>

### Management Access
### Management access

You can configure various access settings for your Unraid server, including enabling Telnet or %%SSH|ssh%%, setting ports for %%SSL|ssl%%/%%TLS|tls%%, HTTP, and HTTPS, and defining the default landing page for Unraid. For detailed information about securing your %%WebGUI|web-gui%% with %%SSL|ssl%% certificates, see [Securing your connection](../../system-administration/secure-your-server/securing-your-connection.mdx).

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Settings - Management Access](/img/settings-management-access.png)
</div>

### Network Settings
### Network settings

By default, Unraid tries to obtain an IP address from a DHCP server on your local network, usually provided by your router. On this page, you can configure a static IP address, set up %%bonding|nic-bonding%%, %%bridging|nic-bridging%%, or explore other options. While setting a static IP is recommended, it is not necessary to use Unraid.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Network Settings](/img/settings-network.png)
</div>

### Power Mode
#### WiFi setup

Unraid supports WiFi connectivity for situations where a wired network connection isn't practical or available. While a wired connection is generally recommended for better stability and performance, a wireless setup can be a suitable alternative when running a cable isn't an option.

:::important[Initial setup requirements]

For the initial WiFi setup, you'll need either:

- A local keyboard and monitor connected to your server (boot into GUI mode), or
- A temporary wired connection to access the %%WebGUI|web-gui%%

Once WiFi is configured, you can remove the wired connection and manage your server wirelessly.

:::

##### Setting up WiFi

1. Access the %%WebGUI|web-gui%% and go to ***Settings → Network Settings → Wireless wlan0***.
2. Enable WiFi by toggling the **Enable WiFi** option.
3. Configure the **Regulatory Region**:
- In most cases, it’s best to leave this set to **Automatic**.
- If your preferred network isn't appearing in the scan results, set it to your specific location (country/region).
4. Scan for available networks:
- Available WiFi networks should be listed.
- Click the **Connect to WiFi network** (ᯤ) icon next to your preferred network.
5. Enter your network credentials:
- Type your WiFi password.
- Review and adjust any additional settings if needed.
- Click **Join this network** to connect.

:::tip[Docker containers and WiFi]

If you plan to use Docker containers with WiFi, ensure to unplug any wired connections **before** starting the Docker service. This helps prevent network configuration conflicts that can occur when both interfaces are active simultaneously.

:::

##### Supported WiFi features

Unraid's WiFi implementation supports the following:

- **WPA2** and **WPA3 security protocols**, including WPA2/WPA3 Enterprise networks. If both WPA2 and WPA3 are available, Unraid will automatically use WPA3 for enhanced security.
- **Modern WiFi adapters** that have Linux in-kernel driver support. Older adapters may not be compatible.

:::info[USB WiFi adapters]

If you're using a USB WiFi adapter, check this list of [USB WiFi adapters supported with Linux in-kernel drivers](https://github.com/morrownr/USB-WiFi/blob/main/home/USB_WiFi_Adapters_that_are_supported_with_Linux_in-kernel_drivers.md) to ensure compatibility.

If your WiFi adapter isn't detected, please start a new thread on the [Unraid forums](https://forums.unraid.net/) and provide your diagnostics for investigation.

:::

##### WiFi limitations

WiFi has some limitations compared to wired networking:

- You can only connect to **one WiFi network** at a time.
- Only one wireless NIC is supported - `wlan0`. If your system has multiple wireless adapters (`wlan1`, `wlan2`, etc.), only `wlan0` will be used.
- Unlike wired connections, you **cannot combine multiple wireless connections** to improve reliability.
- **`wlan0` cannot participate in a bond**. You cannot combine WiFi and Ethernet connections in a bond configuration.
- It's best to use either a wired connection or WiFi, but **not both at the same time**. If you need to temporarily connect or disconnect a network cable while using WiFi, your server should automatically adjust to use the active connection within about a minute. For important information about Docker containers when switching between connection types, see the **Docker and virtual machine considerations** section below.

##### Docker and virtual machine considerations

When using WiFi, there are specific considerations for Docker containers and %%virtual machines|vm%%:

###### Docker containers

- On ***Settings → Docker***, when WiFi is enabled, the system automatically uses **ipvlan** for custom networks (macvlan is not supported with WiFi).
- Host access to custom networks must be disabled in ***Settings → Docker***.
- Container **Network Type** cannot use `br0`, `bond0`, or `eth0`.

:::caution

Docker cannot participate in two networks sharing the same subnet. If you switch between wired and wireless connections, you will need to restart Docker and reconfigure all existing containers to use the new interface. This network configuration change requires container reconfiguration. It's strongly recommended to choose either wired or wireless and not switch between them.
:::

###### Virtual machines

It's recommended to set your %%VM|vm%% **Network Source** to **virbr0** (Private NAT). This mode works with any number of %%VMs|vm%% and provides network access through %%NAT|nat%%. Note that mDNS does not work through NAT, so the %%VM|vm%% will need to access other local network devices by IP address, not hostname. You can add IP addresses and hostnames to the hosts file on the %%VM|vm%% operating system to allow access by hostname. The %%VMs|vm%% won't be directly accessible from other devices on your LAN, but you can still access them via %%VNC|vnc-session%% through the host.

For more information about %%VM|vm%% networking, see [Overview and system prep](../../using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx).

### Power mode

The **Power Mode** setting allows you to optimize your Unraid server for energy efficiency, balanced operation, or maximum performance. You can choose from available modes - **Best power efficiency**, **Balanced operation**, or **Best performance** - to match your workload and energy preferences. Adjusting Power Mode can help reduce power consumption, lower system temperatures, or provide additional resources for demanding tasks.

Expand All @@ -95,59 +177,59 @@ Changes take effect immediately and do not require a system restart.
![Power Mode](/img/settings-powermode.png)
</div>

### Global Share Settings
### Global share settings

%%User shares|user-share%% can greatly simplify the organization and access of content across multiple disks in the %%array|array%%. You have the option to specify which disks are allowed to participate in %%user shares|user-share%% through global inclusion or exclusion settings.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Global Share Settings](/img/settings-globalshare.png)
</div>

### UPS Settings
### UPS settings

Unraid can be connected to an APC (or compatible) UPS (Uninterruptible Power Supply) to allow the system to safely shut down during a power loss while still receiving battery power. You can configure the UPS connection and set policies for the shutdown command on this page.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![UPS Settings](/img/settings-ups.png)
</div>

### VM Manager
### VM manager

**Virtual machines** (VMs) can turn your server into a desktop or media player, and run applications not designed for Linux. For details on managing %%VMs|vm%% on Unraid, see [VM setup](../../using-unraid-to/create-virtual-machines/vm-setup.mdx).
**Virtual machines** can turn your server into a desktop or media player, and run applications not designed for Linux. For details on managing %%VMs|vm%% on Unraid, see [VM setup](../../using-unraid-to/create-virtual-machines/vm-setup.mdx).

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![VM Manager](/img/settings-vmmanager.png)
</div>

## Network Services
## Network services

**Network Services** let you configure network communication protocols on your Unraid server, which are essential for user and disk shares. You can also enable an %%FTP|ftp%% server, a logging server, and set up a %%VPN|vpn-tunnel%% for secure remote access.

### NFS (Network File System)
### NFS (Network file system)

NFSv4 support is available in Unraid. You can enable or disable it for %%user shares|user-share%% and adjust the `fuse_remember` tunable to help resolve *NFS Stale File Handle* errors.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![NFS](/img/settings-nfs.png)
</div>

### SMB (Server Message Block)
### SMB (Server message block)

The SMB protocol is used by Microsoft Windows clients. From this page, you can enable it, define a workgroup, or join an Active Directory domain.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![SMB](/img/settings-smb.png)
</div>

### FTP (File Transfer Protocol)
### FTP (File transfer protocol)

Users can connect via %%FTP|ftp%% only if they are added to the **FTP users** field on this page. If no users are added, the %%FTP|ftp%% service will not start.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![FTP](/img/settings-ftp.png)
</div>

### Syslog Server
### Syslog server

The %%Syslog server|syslog-server%% permanently stores your system log, which is useful for troubleshooting since Unraid clears the log after each reboot.

Expand All @@ -171,15 +253,15 @@ You can also configure your server as a %%Subnet Router|subnet-routing%% for loc
![Tailscale Settings](/img/settings-tailscale.png)
</div>

### VPN Manager
### VPN manager

You can establish a %%VPN|vpn-tunnel%% connection to your Unraid server using [%%Wireguard|wireguard%%](https://www.wireguard.com/) for secure internet connections.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![VPN Manager](/img/settings-vpnmanager.png)
</div>

## User Preferences
## User preferences

User Preferences allow you to configure various aspects of your interactions with Unraid OS, including notifications, display settings, UI customization, and the %%Mover|mover%% schedule.

Expand All @@ -191,23 +273,23 @@ You can enable/disable the requirement for confirmations when performing various
![Confirmations](/img/settings-confirmations.png)
</div>

### Console Settings
### Console settings

Allows you to customize the local system console. You can select the keyboard layout, adjust the screen blanking timeout, and enable or disable persistent Bash history across reboots. These options enhance your experience when using Unraid with a connected monitor and keyboard.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Console Settings](/img/settings-console.png)
</div>

### Display Settings
### Display settings

Customize the Unraid %%WebGUI|web-gui%% appearance on this page by adjusting the date and time format, number format, and toggling between tabbed and non-tabbed views. You can also select the temperature unit and choose from different themes for the user interface.

<div style={{ margin: 'auto', maxWidth: '400px'}}>
![Display Settings](/img/settings-display.png)
</div>

### Notification Settings
### Notification settings

Unraid can send you notifications about important system events, updates, and alerts through your browser, email, or third-party notification services. The Notification Settings page allows you to control how and when you receive these notifications.

Expand Down Expand Up @@ -255,11 +337,11 @@ Enable **Browser** notifications for immediate visibility when using the %%WebGU

:::

#### SMTP Settings
#### SMTP settings

To receive email notifications, you need to configure your email server settings. Unraid supports many email providers including Gmail, Outlook, and custom SMTP servers.

The SMTP Settings can be found at ***Settings → User Preferences → Notification Settings → SMTP Settings***.
The SMTP settings can be found at ***Settings → User Preferences → Notification Settings → SMTP Settings***.

**Basic configuration:**

Expand Down Expand Up @@ -325,7 +407,7 @@ Always use app passwords instead of your main Gmail password. App passwords can

:::

#### Notification Agents
#### Notification agents

Notification agents allow you to send alerts to third-party services and mobile apps. Unraid includes built-in support for many popular notification services.

Expand Down Expand Up @@ -370,7 +452,7 @@ You can enable multiple agents simultaneously. For example, you might use Discor

The Scheduler settings page allows you to easily configure the frequency for automated tasks including %%parity checks|parity-check%%, the cache %%Mover|mover%%, and %%TRIM/Discard|trim-discard%% operations for SSDs.

## User Utilities
## User utilities

Third-party plugins are displayed here, enhancing Unraid’s functionality and giving you more control over your server. For example, the [Community Applications plugin](../../using-unraid-to/run-docker-containers/community-applications.mdx) is included. Other plugins offer features for system monitoring, maintenance, storage management, and `appdata` backups.

Expand Down
2 changes: 1 addition & 1 deletion docs/unraid-os/release-notes/7.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If rolling back earlier than 7.1.4, also see the [7.1.4 release notes](7.1.4.md#

#### ZFS RAIDZ expansion

You can now expand your single-vdev RAIDZ1/2/3 pools, one drive at a time:
You can now expand your single-vdev RAIDZ1/2/3 pools, one drive at a time. For detailed instructions, see [RAIDZ expansion](../../using-unraid-to/manage-storage/cache-pools.mdx#raidz-expansion).

- With the array running, on **_Main → Pool Devices_**, select the pool name to view the details
- In the **Pool Status** area, check for an **Upgrade Pool** button. If one exists, you'll need to click that before continuing. Note that upgrading the pool will limit your ability to downgrade to earlier releases of Unraid (7.1 should be OK, but not 7.0)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ This displays RAM usage in a human-readable format. The `-h` flag means sizes wi

:::tip[Understand the output]

A low "available" memory reading doesnt necessarily indicate a problem—Linux aggressively caches data for performance.
A low "available" memory reading doesn't necessarily indicate a problem—Linux aggressively caches data for performance.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ To enable VM hibernation:

<TabItem value="linux" label="Linux VMs">

1. **Install %%QEMU|qemu%% %%Guest Agent|guest-agent%%:**
1. **Install %%QEMU|qemu%% %%Guest Agent|guest-agent%%:**
```bash
# Ubuntu/Debian
sudo apt install qemu-guest-agent
Expand Down Expand Up @@ -179,7 +179,6 @@ In this section, we’ll cover how to configure timeouts for various systems and
:::tip[When to increase timeouts]

If you're experiencing unclean shutdowns or containers that crash during shutdown, consider increasing the general shutdown timeout to **180 seconds** (or **300+ seconds** if you have multiple %%VMs|vm%%). This gives services more time to shut down gracefully.

:::

### Shutdown sequence
Expand Down Expand Up @@ -226,11 +225,11 @@ This section provides in-depth information about configuring timeouts for differ

Configure VM shutdown timeouts in **_Settings → VM Manager → VM Shutdown_** (enable Advanced view).

**How it works:**
**How it works:**

- %%VMs|vm%% go through three shutdown stages, each consuming the full VM timeout
- All %%VMs|vm%% in each stage are processed simultaneously
- Total VM shutdown time = VM timeout × 3
- %%VMs|vm%% go through three shutdown stages, each consuming the full VM timeout
- All %%VMs|vm%% in each stage are processed simultaneously
- Total VM shutdown time = VM timeout × 3

**Common issues:**

Expand All @@ -248,9 +247,7 @@ Configure VM shutdown timeouts in **_Settings → VM Manager → VM Shutdown_**
:::

:::warning[No safe timeout without hibernation]

Without hibernation and %%QEMU|qemu%% %%Guest Agent|guest-agent%%, there isn't a truly safe timeout for Windows %%VMs|vm%%. Dialog boxes or ongoing update installations could render any timeout inadequate, leading to forced shutdowns and data corruption risk.

:::

#### Docker timeouts
Expand Down
Loading
Loading