Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/API/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Switch between production and staging environments.

### Developer Mode

:::tip Web GUI Management
:::tip[Web GUI Management]

You can also manage developer options through the web interface at **Settings** → **Management Access** → **Developer Options**

Expand All @@ -113,7 +113,7 @@ Configure developer features for the API:

## API Key Management

:::tip Web GUI Management
:::tip[Web GUI Management]

You can also manage API keys through the web interface at **Settings** → **Management Access** → **API Keys**

Expand All @@ -137,7 +137,7 @@ Options:

## SSO (Single Sign-On) Management

:::info OIDC Configuration
:::info[OIDC Configuration]

For OIDC/SSO provider configuration, see the web interface at **Settings** → **Management Access** → **API** → **OIDC** or refer to the [OIDC Provider Setup](./oidc-provider-setup.mdx) guide.

Expand Down
2 changes: 1 addition & 1 deletion docs/API/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ For Unraid versions prior to v7.2 or to access newer API features:
2. [Configure the plugin](./how-to-use-the-api.mdx#enabling-the-graphql-sandbox)
3. Access API functionality through the [GraphQL Sandbox](./how-to-use-the-api.mdx)

:::info Important Notes
:::info[Important Notes]

- The Unraid Connect plugin provides the API for pre-7.2 versions
- You do NOT need to sign in to Unraid Connect to use the API locally
Expand Down
10 changes: 5 additions & 5 deletions docs/API/upcoming-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 10

# Roadmap & Features

:::info Development Status
:::info[Development Status]

This roadmap outlines completed and planned features for the Unraid API. Features and timelines may change based on development priorities and community feedback.

Expand Down Expand Up @@ -129,7 +129,7 @@ This roadmap outlines completed and planned features for the Unraid API. Feature

## Recent Releases

:::info Full Release History
:::info[Full Release History]

For a complete list of all releases, changelogs, and download links, visit the [Unraid API GitHub Releases](https://github.com/unraid/api/releases) page.

Expand All @@ -150,7 +150,7 @@ For a complete list of all releases, changelogs, and download links, visit the [

## Community Feedback

:::tip Have a Feature Request?
:::tip[Have a Feature Request?]

Community feedback received; API open-sourced January 2025! Please submit feature requests and feedback through:

Expand All @@ -168,13 +168,13 @@ Community feedback received; API open-sourced January 2025! Please submit featur
| 6.12.x | v4.x via Plugin | ⚠️ Limited |
| \< 6.12 | Not Supported | ❌ EOL |

:::warning Legacy Support
:::warning[Legacy Support]

Versions prior to Unraid 7.2 require the API to be installed through the Unraid Connect plugin. Some features may not be available on older versions.

:::

:::tip Pre-release Versions
:::tip[Pre-release Versions]

You can always install the Unraid Connect plugin to access pre-release versions of the API and get early access to new features before they're included in Unraid OS releases.

Expand Down
4 changes: 2 additions & 2 deletions docs/contribute/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Lists help users absorb, recall, and follow key points or steps. There are two m
- **Ordered lists** (numbered): Use to show a required sequence or procedure.
*Example:* "To start the %%array|array%%..."

:::tip Best practices
:::tip[Best practices]

- Try to introduce the list with a clear stem sentence ending in a colon.
- Use 4–6 items max in an unordered list for ease of scanning and memorability. Longer lists may be better as a table.
Expand All @@ -96,7 +96,7 @@ Lists help users absorb, recall, and follow key points or steps. There are two m

Tables are a great way to organize related data by grouping information into rows and columns, which makes comparisons quicker and more precise.

:::tip Best practices
:::tip[Best practices]

- Use tables for multiple related data points that benefit from side-by-side comparison.
- Avoid tables with only 1 or 2 cells; instead, use bulleted lists or sentences.
Expand Down
2 changes: 1 addition & 1 deletion docs/unraid-connect/automated-flash-backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ To protect your privacy, the following are **never** stored in cloud backups:
- Unraid root or user account passwords
- Public, private, or shared %%WireGuard|wireguard%% keys

:::note reminder
:::note[Reminder]

Flash backup is for configuration recovery only. Always incorporate additional backup strategies for your data and critical secrets.

Expand Down
4 changes: 2 additions & 2 deletions docs/unraid-connect/remote-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

Unlock secure, browser-based access to your Unraid %%WebGUI|web-gui%% from anywhere with remote access. This feature is ideal for managing your server when you're away from home - no complicated networking or %%VPN Tunnel|vpn-tunnel%% setup is required. For more advanced needs, such as connecting to Docker containers or accessing network drives, a %%VPN Tunnel|vpn-tunnel%% remains the recommended solution.

:::important Security reminder
:::important[Security reminder]

Before enabling remote access, ensure your root password is strong and unique. Update it on the **Users** page if required. Additionally, keep your Unraid OS updated to the latest version to protect against security vulnerabilities. [Learn more about updating Unraid here](../unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx).

Expand Down Expand Up @@ -114,7 +114,7 @@ To configure %%UPnP|upnp%%:

For Dynamic forwarding, you need to click **Enable Dynamic Remote Access** in [Unraid Connect](https://connect.myunraid.net/) to allow access.

:::caution **Troubleshooting**
:::caution[Troubleshooting]

If the setting changes from %%UPnP|upnp%% to Manual Port Forward upon reloading, Unraid might not be able to communicate with your router. Double-check that %%UPnP|upnp%% is enabled and consider updating your router's firmware.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem';

# ZFS storage

:::important Special thanks
:::important[Special thanks]

We’d like to express our thanks to Ed Rawlings ([Spaceinvader One](https://www.youtube.com/c/SpaceinvaderOne)) for the expertise and guidance that this %%ZFS|zfs%% storage documentation has been adapted from. His tutorials and insights have assisted countless Unraid users in mastering advanced storage techniques. We appreciate his continued contributions to the Unraid community.

Expand All @@ -32,7 +32,7 @@ With %%ZFS|zfs%%, you gain:

Unraid supports %%ZFS|zfs%% for any storage pool. You can create a new %%ZFS|zfs%% pool, import one from another system, or use Unraid’s unique hybrid %%ZFS|zfs%% setup: add a %%ZFS|zfs%%-formatted disk directly to the Unraid %%array|array%% (not a pool) and combine %%ZFS|zfs%% features with Unraid’s %%parity|parity%% protection.

:::info Example
:::info[Example]

You can use %%ZFS|zfs%% %%snapshots|snapshot%% and replication on a single disk as a backup target, or replicate a fast SSD %%ZFS|zfs%% pool to a %%ZFS|zfs%% disk in the %%array|array%% protected by Unraid %%parity|parity%% - getting the best of both worlds.

Expand Down Expand Up @@ -126,7 +126,7 @@ Before finalizing, review the sections on allocation profiles and topology to ma

You can add a standalone %%ZFS|zfs%% disk to your Unraid %%array|array%% (not a %%ZFS|zfs%% pool) to combine %%ZFS|zfs%% features with Unraid's %%parity|parity%% protection.

:::info What this enables
:::info[What this enables]

- **Parity protection:** The ZFS disk is protected by Unraid’s %%array|array%% %%parity|parity%%, ensuring your data is safe from single (or multiple, depending on your %%parity drives|parity-drives%%) disk failures.

Expand Down Expand Up @@ -174,7 +174,7 @@ When you set up a %%ZFS|zfs%% pool, your allocation profile determines how your
| RAIDZ2 | 2 disks per vdev | Like Z1 but slightly slower writes (extra parity) | Add new vdevs | Moderate | Important data, 2-disk fault tolerance |
| RAIDZ3 | 3 disks per vdev | Like Z2, with more write overhead (for maximum safety) | Add new vdevs | Lower | Mission-critical, 3-disk fault tolerance |

:::important How to choose
:::important[How to choose]

- Use **Mirror** if you want the best performance and easy, flexible expansion, and are okay with using more disk space for redundancy.
- Choose **RAIDZ1/2/3** if you want to maximize usable space and store large files, but keep in mind that expansion is less flexible, and random write performance is lower.
Expand Down Expand Up @@ -262,7 +262,7 @@ Unraid can import %%ZFS|zfs%% pools created on other platforms with minimal hass
4. **Set file system to "Auto":** Click the pool name (e.g., `raptor`) and set **File System** to **Auto**.
5. **Finish and start array:** Click **Done**, then start the %%array|array%%.

:::info Automatic detection
:::info[Automatic detection]

Unraid will automatically detect and import the %%ZFS|zfs%% pool. Support vdevs (like log, cache/L2ARC, special/dedup) are listed under **Subpools** in the %%WebGUI|web-gui%%. There is no need to add subpools separately after initiating the import. Unraid will automatically import them alongside the main data disks when all required drives are assigned.

Expand Down Expand Up @@ -335,7 +335,7 @@ Ways to expand your pool include:
- **Replacing drives with larger ones:** Swap each drive in a vdev, one at a time, for a larger disk. See [drive replacement](../../using-unraid-to/manage-storage/array-configuration.mdx#replacing-faileddisabled-disks) for detailed procedures. After all drives are replaced and the pool resolves, the vdev’s capacity increases.
- **Creating a new pool:** Starting a new %%ZFS|zfs%% pool keeps things organized and independent for different data types or workloads.

:::tip Planning ahead
:::tip[Planning ahead]

Before building your pool, consider how much storage you’ll need - not just today, but in the future. %%ZFS|zfs%% rewards good planning, especially if you want to avoid disruptive upgrades later.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Customize Unraid settings

Unraid OS automatically functions but allows further customization of settings such as IP address, hostname, disk tunables, and more via the **Settings** tab in the Unraid **%%WebGUI|web-gui%%**.

:::tip Tailscale integration
:::tip[Tailscale integration]

**Tailscale** is an optional plugin that you can install via the **Apps** tab by searching for "Tailscale". It provides secure remote access to your network and adds a **Tailscale** section to your **Settings** for enhanced remote management capabilities.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Deploy & configure Unraid OS

After booting Unraid OS for the first time, you'll use the %%WebGUI|web-gui%% to complete your system configuration. This interface lets you manage your server, set up storage, configure user shares, and control features like %%hardware virtualization|hvm%% and Docker containers.

:::info Localize
:::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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';

While most tasks in Unraid can be performed through the %%WebGUI|web-gui%%, certain operations - especially those related to diagnostics, drive management, or scripting - require using the system console or %%SSH|ssh%% terminal. This page offers Unraid-specific command-line tools and examples that can be used without needing extensive Linux knowledge.

:::tip Device paths
:::tip[Device paths]

Many disk-level Unraid operations depend on Linux device names, like `/dev/sdX`. You can find the device identifier for any drive in the **Main** tab of the %%WebGUI|web-gui%%. Look for the three-letter label `sdX` or `nvmeX` next to each disk. Use the appropriate identifier in all commands, replacing `sdX` with your specific disk.

Expand All @@ -22,7 +22,7 @@ Unraid includes a built-in web terminal that you can access directly from the %%

You can also connect to your Unraid server externally using %%SSH|ssh%% (secure shell) with a client like %%PuTTY|putty%%.

:::tip When should I use the terminal?
:::tip[When should I use the terminal?]

Terminal access is useful for:

Expand Down Expand Up @@ -186,7 +186,7 @@ This command shows memory usage statistics.

This displays RAM usage in a human-readable format. The `-h` flag means sizes will show in KB, MB, or GB instead of bytes.

:::tip Understand the output
:::tip[Understand the output]

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 @@ -29,7 +29,7 @@ For WoL to work properly, make sure you meet the following requirements:

- **Network connection**: Connect your server to your LAN with an Ethernet cable (WiFi WoL is not supported).

:::caution Hardware compatibility
:::caution[Hardware compatibility]

Not all hardware supports S3 sleep or WoL reliably. Some systems may experience issues entering sleep, fail to wake up correctly, or require additional BIOS/%%UEFI|uefi%% settings. Always test these features thoroughly before relying on them.

Expand Down Expand Up @@ -76,7 +76,7 @@ The plugin manages most sleep configuration options.
echo -n mem > /sys/power/state
```

:::caution Persistence
:::caution[Persistence]

WoL settings configured manually are **not persistent** across reboots by default. To make them permanent:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ When choosing a new USB flash drive for Unraid, focus on reliability and compati

For more guidance on selecting the best flash device for Unraid, check out [Spaceinvader One's video guide on USB flash drive testing](https://www.youtube.com/watch?v=jjkaidlZmgs).

:::tip Rules of thumb for replacement
:::tip[Rules of thumb for replacement]

- Buy USB drives from reputable retailers and avoid auction sites and unknown sellers.
- Avoid second-hand or previously used drives.
Expand All @@ -60,7 +60,7 @@ The [forum announcement on counterfeit SanDisk drives](https://forums.unraid.net

## Replacing your USB flash device

:::caution Before you replace
:::caution[Before you replace]

Before replacing your current flash device, consider checking it for errors:

Expand Down Expand Up @@ -100,15 +100,15 @@ There are two ways to replace your Unraid USB flash device: the recommended [USB
</TabItem>
</Tabs>

:::tip Backup best practices
:::tip[Backup best practices]

- Regularly back up your flash device, especially after major configuration changes.
- Store backups off-server (on another computer or cloud storage).
- Keep a screenshot of your disk assignments after any hardware changes.

:::

:::important Trial keys and device changes
:::important[Trial keys and device changes]

If you transfer a trial configuration to a new flash device, you will not be able to start the %%array|array%% until you purchase a valid registration key. Trial keys only work on the original device.

Expand Down Expand Up @@ -158,7 +158,7 @@ If you transfer a trial configuration to a new flash device, you will not be abl
<TabItem value="manual" label="Manual method">
*Use this method if the USB flash creator tool does not work for your system.*

:::important Before you begin
:::important[Before you begin]

Use the manual method only if you are comfortable with basic file management and your system does not support the USB flash creator.

Expand Down Expand Up @@ -214,7 +214,7 @@ Never assign a data disk as a %%parity drive|parity-drives%%. Incorrect assignme

:::

:::tip Identifying drives
:::tip[Identifying drives]

- **%%Parity drives|parity-drives%%** do not have a mountable file system. If a drive cannot be mounted, it is likely a %%parity|parity%% drive.
- **Data drives** previously used by Unraid retain their data even after resetting the %%array|array%% configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import TabItem from '@theme/TabItem';

Upgrading Unraid OS ensures that you have the latest features, security updates, and hardware support. This page outlines the standard upgrade process, along with troubleshooting tips and manual upgrade options.

:::note Prerequisites
:::note[Prerequisites]

Before you start upgrading, make sure to create a complete backup of your USB flash device. For more details, refer to [Backing up your flash device](../maintain-and-update/changing-the-flash-device.mdx#backing-up-your-flash-device).

:::

:::tip Best practices before upgrading
:::tip[Best practices before upgrading]

1. **Make a backup** of your flash drive and any important data.
2. **Read the Release Notes** for the version you plan to install.
Expand Down Expand Up @@ -60,13 +60,13 @@ Before you start upgrading, make sure to create a complete backup of your USB fl
</TabItem>
</Tabs>

:::caution ZFS pool upgrade warnings
:::caution[ZFS pool upgrade warnings]

When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version
When upgrading to Unraid 7.x, you may see warnings about [%%ZFS|zfs%%](../../advanced-configurations/optimize-storage/zfs-storage.mdx) pool feature upgrades during boot or in the %%WebGUI|web-gui%%. These warnings are not a sign of a problem; they simply indicate that your %%ZFS|zfs%% pool is using features from an older version of ZFS.

Upgrading your pool isn't urgent, but if you do decide to upgrade, keep in mind that it may not work with previous versions of Unraid. This means you may not be able to revert to a previous Unraid version after making the upgrade.

As always, remember to back up your data before upgrading your %%ZFS|zfs%% pools
As always, remember to back up your data before upgrading your %%ZFS|zfs%% pools.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can control whether your flash drive is accessible over the network, similar
- **Network visibility:** Decide if your flash drive should be visible or hidden on your network.
- **Access rights:** If network access is enabled, set permissions to limit who can view or modify its contents.

:::important Reducing security risks
:::important[Reducing security risks]

- **Disable sharing:** Set the flash drive's %%SMB|samba%% export to **No** to prevent network access entirely.
- **Restrict access:** If you must share the flash drive, set security to **Private** and grant access only to trusted users with strong passwords.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For additional information about plugin development and compatibility, visit the

%%Tailscale|tailscale%% exit nodes offer a secure and modern way to route your Unraid server's outgoing traffic through another device on your %%Tailnet|tailnet%%. This setup provides the security of a %%VPN|vpn-tunnel%% while leveraging %%Tailscale|tailscale%%'s easy-to-use mesh networking, making it ideal for users who want encrypted outgoing traffic without the complexity of traditional %%VPN|vpn-tunnel%%s.

:::tip When to use Tailscale exit nodes
:::tip[When to use Tailscale exit nodes]

Consider using %%Tailscale|tailscale%% exit nodes for:

Expand Down
Loading