From 2eb17c9a584eb34c5cdd17527b4c7553a2c89c71 Mon Sep 17 00:00:00 2001 From: ljm42 Date: Tue, 23 Sep 2025 10:40:43 -0700 Subject: [PATCH 1/4] chore: fix admonition markdown --- docs/API/cli.mdx | 6 +-- docs/API/index.mdx | 2 +- docs/API/upcoming-features.mdx | 10 ++--- docs/contribute/style-guide.mdx | 4 +- docs/unraid-connect/remote-access.mdx | 2 +- .../optimize-storage/zfs-storage.mdx | 12 +++--- .../customize-unraid-settings.mdx | 2 +- .../deploy-and-configure-unraid-os.mdx | 2 +- .../advanced-tools/command-line-interface.mdx | 6 +-- .../advanced-tools/wake-on-lan.mdx | 4 +- .../changing-the-flash-device.mdx | 12 +++--- .../maintain-and-update/upgrading-unraid.mdx | 6 +-- .../secure-your-flash-drive.mdx | 2 +- .../secure-your-outgoing-comms.mdx | 2 +- .../securing-your-connection.mdx | 6 +-- .../secure-your-server/securing-your-data.mdx | 2 +- .../security-fundamentals.mdx | 6 +-- .../secure-your-server/tailscale.mdx | 12 +++--- .../secure-your-server/user-management.mdx | 6 +-- .../secure-your-server/wireguard.mdx | 4 +- .../common-issues/data-recovery.mdx | 16 ++++---- docs/unraid-os/troubleshooting/faq.mdx | 6 +-- .../troubleshooting/troubleshooting.mdx | 4 +- .../vm-conversion-and-migration.mdx | 16 ++++---- .../create-virtual-machines/vm-setup.mdx | 10 ++--- .../windows-on-a-vm.mdx | 10 ++--- .../multi-language-support.mdx | 4 +- .../customize-your-experience/plugins.mdx | 2 +- .../manage-storage/apple-time-machine.mdx | 2 +- .../manage-storage/array-configuration.mdx | 40 +++++++++---------- .../manage-storage/cache-pools.mdx | 30 +++++++------- .../manage-storage/file-systems.mdx | 22 +++++----- .../using-unraid-to/manage-storage/shares.mdx | 14 +++---- .../community-applications.mdx | 4 +- .../managing-and-customizing-containers.mdx | 12 +++--- .../run-docker-containers/overview.mdx | 2 +- 36 files changed, 151 insertions(+), 151 deletions(-) diff --git a/docs/API/cli.mdx b/docs/API/cli.mdx index ebb381318f..f68b7a0965 100644 --- a/docs/API/cli.mdx +++ b/docs/API/cli.mdx @@ -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** @@ -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** @@ -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. diff --git a/docs/API/index.mdx b/docs/API/index.mdx index 05e8c6da0a..a935724d4f 100644 --- a/docs/API/index.mdx +++ b/docs/API/index.mdx @@ -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 diff --git a/docs/API/upcoming-features.mdx b/docs/API/upcoming-features.mdx index 39a93c2f7b..d279d19177 100644 --- a/docs/API/upcoming-features.mdx +++ b/docs/API/upcoming-features.mdx @@ -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. @@ -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. @@ -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: @@ -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. diff --git a/docs/contribute/style-guide.mdx b/docs/contribute/style-guide.mdx index 8a12761c14..2438b90af0 100644 --- a/docs/contribute/style-guide.mdx +++ b/docs/contribute/style-guide.mdx @@ -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. @@ -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. diff --git a/docs/unraid-connect/remote-access.mdx b/docs/unraid-connect/remote-access.mdx index 36244d65ed..e8d8f2f5b0 100644 --- a/docs/unraid-connect/remote-access.mdx +++ b/docs/unraid-connect/remote-access.mdx @@ -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). diff --git a/docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx b/docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx index fe2555b21d..652ec08e08 100644 --- a/docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx +++ b/docs/unraid-os/advanced-configurations/optimize-storage/zfs-storage.mdx @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. diff --git a/docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx b/docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx index 758c324017..cbc268cc36 100644 --- a/docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx +++ b/docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx @@ -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. diff --git a/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx b/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx index 12b257948b..bd1f87aa04 100644 --- a/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx +++ b/docs/unraid-os/getting-started/set-up-unraid/deploy-and-configure-unraid-os.mdx @@ -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. diff --git a/docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx b/docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx index 2e10d5ec3c..6701d13d7f 100644 --- a/docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx +++ b/docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx @@ -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. @@ -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: @@ -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. diff --git a/docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx b/docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx index b091e2670d..a8a542d88a 100644 --- a/docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx +++ b/docs/unraid-os/system-administration/advanced-tools/wake-on-lan.mdx @@ -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. @@ -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: diff --git a/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx b/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx index 317a40bc57..f871ec7247 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx +++ b/docs/unraid-os/system-administration/maintain-and-update/changing-the-flash-device.mdx @@ -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. @@ -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: @@ -100,7 +100,7 @@ There are two ways to replace your Unraid USB flash device: the recommended [USB -:::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). @@ -108,7 +108,7 @@ There are two ways to replace your Unraid USB flash device: the recommended [USB ::: -:::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. @@ -158,7 +158,7 @@ If you transfer a trial configuration to a new flash device, you will not be abl *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. @@ -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. diff --git a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx b/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx index 258dd597c7..398ad898f6 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx +++ b/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx @@ -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. @@ -60,7 +60,7 @@ Before you start upgrading, make sure to create a complete backup of your USB fl -:::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 diff --git a/docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx b/docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx index 4ceb876e85..c913540350 100644 --- a/docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/secure-your-flash-drive.mdx @@ -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. diff --git a/docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx b/docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx index 432e6d3959..9e5cb5155a 100644 --- a/docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms.mdx @@ -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: diff --git a/docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx b/docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx index e3feedc821..fc3a966f2d 100644 --- a/docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/securing-your-connection.mdx @@ -7,7 +7,7 @@ sidebar_label: Securing your connection Securing your Unraid %%WebGUI|web-gui%% with %%SSL|ssl%% encryption protects sensitive data—such as login credentials and configuration details—from interception or tampering on your local network or the internet. You can use wildcard %%SSL|ssl%% certificates provisioned by [Let's Encrypt](https://letsencrypt.org/) for both local and [Unraid Connect Remote Access](../../../unraid-connect/remote-access.mdx) scenarios. -:::important The importance of SSL +:::important[The importance of SSL] %%SSL|ssl%% (Secure Sockets Layer) encrypts all traffic between your browser and the Unraid server, preventing eavesdropping and man-in-the-middle attacks. Without %%SSL|ssl%%, anyone with access to your network could potentially intercept sensitive data or hijack your session. Using %%SSL|ssl%% is strongly recommended for both local and remote management of your Unraid server. @@ -129,7 +129,7 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y ::: - :::tip Fallback access + :::tip[Fallback access] If %%DNS|dns-name-resolution%% resolution becomes unavailable (e.g., your Internet goes down), you can use the local URLs with your server name or IP address as backup access methods. @@ -200,7 +200,7 @@ Custom certificates allow you to secure your Unraid %%WebGUI|web-gui%% with your A custom certificate is any %%SSL|ssl%% certificate that you provide and manage yourself, rather than one generated by Unraid or Let's Encrypt. This is useful if you want to use your own domain name, a wildcard certificate, or integrate with your organization's PKI infrastructure. -:::info When using a custom certificate, you are responsible for... +:::info[When using a custom certificate, you are responsible for...] - Procuring the certificate from a trusted certificate authority (CA) - Managing %%DNS|dns-name-resolution%% records for your chosen domain diff --git a/docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx b/docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx index 746b857e2e..98724bd2cb 100644 --- a/docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/securing-your-data.mdx @@ -32,7 +32,7 @@ Encrypting a drive will erase all existing data on that drive. ::: -:::important Before encrypting +:::important[Before encrypting] Move all data off the drive you want to encrypt to another location (another drive in your %%array|array%%, a %%cache pool|cache-pool%%, or external backup). For details on safely moving your data, see [Converting to a new file system type](../../using-unraid-to/manage-storage/file-systems.mdx#converting-to-a-new-file-system-type). diff --git a/docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx b/docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx index 8a3be0f6d5..21ea6e566f 100644 --- a/docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx @@ -5,7 +5,7 @@ sidebar_label: Security fundamentals # Security fundamentals -:::note Principle of least privilege +:::note[Principle of least privilege] The principle of least privilege means granting users and devices only the minimum access necessary to perform their tasks, never more. This approach limits potential damage from compromised accounts or accidental actions and is a core concept in modern security, including zero trust models. Apply this principle throughout your Unraid configuration, especially when creating share users and assigning permissions. @@ -59,7 +59,7 @@ By tweaking these options, you can manage who can see and access each share, mak Share security controls how users access shared files on your system. You can set up a share to require a username and password for accessing files, limit access to read-only, or make it completely public with no credentials needed. -:::note Example +:::note[Example] If you create a `movies` share on your Unraid server, you can choose whether to require a valid username and password just for reading data or allow public access. If you need to add users, a %%root user|root-user%% can create share users by following the process in [**User management**](./user-management.mdx#add-users). @@ -75,7 +75,7 @@ The **Security** setting has the following options: | **Secure** | Limited access: Everyone can read, but only certain users can write. | Good for shared projects where collaboration is needed, like team folders. | | **Private** | Restricted access: Only specific users can read or write. | Ideal for sensitive information, such as financial records or personal documents. | -:::caution Windows SMB access +:::caution[Windows SMB access] Modern versions of Windows (Windows 10 1709+, Windows 11, Server 2019+) block access to **Public** (guest/anonymous) %%SMB|samba%% shares by default, due to stricter security policies. Attempting to connect to a public share will usually fail unless you manually enable insecure guest logons in Windows settings - which is not recommended for security reasons. diff --git a/docs/unraid-os/system-administration/secure-your-server/tailscale.mdx b/docs/unraid-os/system-administration/secure-your-server/tailscale.mdx index 246675de7c..856b5b6e44 100644 --- a/docs/unraid-os/system-administration/secure-your-server/tailscale.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/tailscale.mdx @@ -78,7 +78,7 @@ Unraid makes it easy to connect [Docker containers](../../using-unraid-to/run-do -:::warning Container compatibility +:::warning[Container compatibility] Tailscale integration does not work with all containers. Some containers may not function at all if Tailscale is enabled, particularly those with: @@ -90,7 +90,7 @@ Test Tailscale integration on non-critical containers first, and be prepared to ::: -:::note Prerequisites +:::note[Prerequisites] - First, install %%Tailscale|tailscale%% on any computer that will access your Docker containers. - While the Unraid Tailscale plugin isn’t strictly required for Docker integration, it’s strongly recommended to install it and sign in on your Unraid server for the best experience. @@ -116,7 +116,7 @@ An HTTPS certificate will be generated for this hostname and published in a publ 8. The Tailscale **Userspace Networking** field is usually set automatically. Leave it disabled unless you have a specific need. 9. Decide whether to enable **%%Tailscale|tailscale%% %%SSH|ssh%%** (secure shell access authenticated via %%Tailscale|tailscale%%). -:::info Serve vs. Funnel +:::info[Serve vs. Funnel] - **Serve**: Lets you access a container’s website or web service securely from your Tailnet using a friendly HTTPS URL. No port forwarding is needed, and only Tailnet devices can connect. - **Funnel**: Publishes the container’s website to the public internet via a unique HTTPS URL. Anyone with the link can access it, even if they’re not on your Tailnet. Use this with caution, as it exposes your service to the wider internet. @@ -133,7 +133,7 @@ When using Serve or Funnel, there’s no extra authentication layer - your conta 11. **Apply** your changes and check the **Container log** for Tailscale messages. Click the "To authenticate, visit" link to approve the container on your Tailnet. -:::caution Troubleshooting +:::caution[Troubleshooting] **Persistent state error** - If you see "*ERROR: Couldn't detect persistent Docker directory for .tailscale\_state*": @@ -170,7 +170,7 @@ To update %%Tailscale|tailscale%%: - **Disabled:** The container has full %%Tailnet|tailnet%% access and can use %%Tailscale|tailscale%% DNS. It can communicate with other %%Tailnet|tailnet%% devices, but the original WebUI URL may not be available. -:::info Feature requirements +:::info[Feature requirements] - Containers set as **Exit Nodes** always have userspace networking enabled. - Containers that **Use an Exit Node** always have userspace networking disabled. @@ -188,7 +188,7 @@ The behavior of Tailscale integration and userspace networking depends on the co | `eth0`/`br0`/`bond0` | Disabled | Yes | Yes | Yes | Both URLs accessible regardless of setting | | `container`/`wg0` | Disabled (untested) | Yes | Unknown | Unknown | Use with caution; not fully tested | -:::info Keep in mind +:::info[Keep in mind] - %%Tailscale|tailscale%% WebUI URLs are only accessible from devices with %%Tailscale|tailscale%% installed and joined to your %%Tailnet|tailnet%%, or with explicit sharing enabled. - For most users, default settings provide secure and reliable access. Advanced options are available for specialized networking needs. diff --git a/docs/unraid-os/system-administration/secure-your-server/user-management.mdx b/docs/unraid-os/system-administration/secure-your-server/user-management.mdx index c7f84ff5ba..9447ed629a 100644 --- a/docs/unraid-os/system-administration/secure-your-server/user-management.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/user-management.mdx @@ -7,7 +7,7 @@ sidebar_label: User management Unraid makes managing users on your NAS simple and secure, catering to everyone from beginners to experienced users. The streamlined approach helps reduce confusion while ensuring that security and access control remain strong. -:::note Simplified approach +:::note[Simplified approach] Unlike traditional Linux systems, Unraid offers a straightforward user model: @@ -72,7 +72,7 @@ To add a user: - **Password**: Create a strong password using a mix of letters, numbers, and symbols. Follow the password strength meter for guidance. -:::note Optionally +:::note[Optionally] - **Add a description**: Write a note like "Media Library Access." - **Custom image**: Upload a PNG image (like a user avatar) for visual identification. @@ -169,7 +169,7 @@ import TabItem from '@theme/TabItem'; -:::tip Be aware +:::tip[Be aware] Anyone with physical access to the USB can use these methods to reset your %%root|root-user%% password and gain full administrative access. Always keep your USB secure! diff --git a/docs/unraid-os/system-administration/secure-your-server/wireguard.mdx b/docs/unraid-os/system-administration/secure-your-server/wireguard.mdx index 67031173ac..945e210ab0 100644 --- a/docs/unraid-os/system-administration/secure-your-server/wireguard.mdx +++ b/docs/unraid-os/system-administration/secure-your-server/wireguard.mdx @@ -42,7 +42,7 @@ Knowing the connection types in %%WireGuard|wireguard%% can help you decide if i ## Setting up WireGuard on Unraid -:::note Prerequisites +:::note[Prerequisites] - **Dynamic DNS:** Set up DDNS for reliable access if your public IP changes. Popular options include [Cloudflare](https://www.cloudflare.com/) (requires domain ownership), [No-IP](https://www.noip.com/), or [DuckDNS](https://www.duckdns.org/) (free but may experience occasional outages). - **Router configuration:** @@ -100,7 +100,7 @@ Store the private key securely since it provides full network access. ![Activation toggle](/img/activate.png) -:::important Security best practices +:::important[Security best practices] - **Trusted access only:** VPN access is similar to physical network access, so only authorize trusted devices. - **Key management:** Never share private keys; treat them like passwords. diff --git a/docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx b/docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx index bfddae9212..62354e78bc 100644 --- a/docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/data-recovery.mdx @@ -30,13 +30,13 @@ Even though Unraid offers protection against various hardware failures, having r Users should assess their risk tolerance and backup needs, but utilizing cloud integration and automation is a good starting point for most Unraid users. -:::tip Modern backup strategy +:::tip[Modern backup strategy] With Unraid 7.0 and up, enable [Unraid Connect](../../../unraid-connect/overview-and-setup.mdx) for automated cloud backups of your flash device and configuration. Consider using Duplicati, rclone, or similar tools for important files and shares to create scheduled backups to local, remote, or cloud destinations. Always test your restore process to ensure your backups will work when needed. ::: -:::info Proactive monitoring and support +:::info[Proactive monitoring and support] - **Enable notifications:** Set up notifications in ***Settings → Notifications*** to receive immediate alerts about system issues. - **Seek expert guidance:** If you're unsure about recovery steps, consult the [Unraid forums](https://forums.unraid.net/) before taking any action. @@ -97,7 +97,7 @@ If you prefer using the command line, always: - **XFS:** `xfs_repair` - **BTRFS:** `btrfs scrub` -:::caution Know your file system +:::caution[Know your file system] Using the wrong repair tool can cause further damage. Verify that your disk is formatted as **%%XFS|xfs%%**, **%%BTRFS|btrfs%%**, or another supported file system type before initiating repairs. @@ -171,7 +171,7 @@ This section covers how to diagnose and repair file system corruption on data dr If you used %%Maintenance Mode|maintenance-mode%%, stop the array and restart it in normal mode to resume operations. -:::tip What to expect after repair +:::tip[What to expect after repair] - Repair and check operations may take up to a half hour or more, depending on the size and status of your file system. - Extensive corruption may create a `lost+found` folder containing recovered file and folder fragments. Examine and restore these as needed; delete when finished. @@ -220,7 +220,7 @@ If you used %%Maintenance Mode|maintenance-mode%%, stop the array and restart it If a previously functional disk becomes unmountable, this usually indicates file system corruption, often caused by an unclean shutdown or write failure. -:::danger Critical action +:::danger[Critical action] Never format an unmountable disk through the %%WebGUI|web-gui%%! Formatting erases all data and updates %%parity|parity%%, making recovery impossible. ::: @@ -285,7 +285,7 @@ Here’s what to do if you find yourself in this situation: When standard Unraid recovery methods, such as the [replacing disks](../../using-unraid-to/manage-storage/array-configuration.mdx#replacing-disks) procedure, aren't feasible due to multiple disk failures or invalid %%parity|parity%%, specialized tools like **ddrescue** can help you salvage as much data as possible from a failing drive. -:::note Best practices for data recovery +:::note[Best practices for data recovery] Before you begin, remember that data recovery is a delicate process. Always work from a copy of your failing disk when possible, and avoid writing new data to the source disk. If your data is irreplaceable, consider professional recovery services before attempting advanced recovery yourself. Document your actions and take time—rushing increases the risk of permanent data loss. @@ -343,7 +343,7 @@ time since last successful read: 0s Copying non-tried blocks... Pass 1 (forwards) ``` -:::note What does this mean? +:::note[What does this mean?] - **ipos/opos**: Current read/write positions on the source and destination disks. - **rescued**: Amount of data successfully copied. @@ -369,7 +369,7 @@ time since last successful read: 10s Scraping failed blocks... (forwards) ``` -:::note What’s happening now? +:::note[What's happening now?] - **Scraping failed blocks...**: ddrescue is making repeated attempts to recover unreadable sectors. - **bad areas/read errors**: These numbers may increase as ddrescue finds more damage, but the goal is to minimize unrecoverable data. diff --git a/docs/unraid-os/troubleshooting/faq.mdx b/docs/unraid-os/troubleshooting/faq.mdx index 50172f41c1..0f1e06c393 100644 --- a/docs/unraid-os/troubleshooting/faq.mdx +++ b/docs/unraid-os/troubleshooting/faq.mdx @@ -160,7 +160,7 @@ If you need help with Unraid OS, you have several support options: 6. In the %%WebGUI|web-gui%%, open a terminal and run `lsblk` to list all drives (excluding the flash). 7. Wipe existing filesystems from each data drive: - :::danger Critical: Destructive Operation + :::danger[Critical: Destructive Operation] **This step will permanently erase ALL data on the specified drive(s) and is IRREVERSIBLE!** @@ -292,7 +292,7 @@ If you need help with Unraid OS, you have several support options:

Why convert from MBR to GPT?

MBR (Master Boot Record) partitioning supports disks up to 2TB and only allows a maximum of four primary partitions. On the other hand, GPT (%%GUID|guid%% Partition Table) can handle much larger disks and nearly unlimited partitions. Converting to GPT is advisable if you work with larger drives or want better partition management. - :::important Use **Maintenance Mode** + :::important[Use **Maintenance Mode**] Before starting the conversion process, put your %%array|array%% into **Maintenance Mode**. This step ensures no writes occur during the conversion, protecting your data. @@ -310,7 +310,7 @@ If you need help with Unraid OS, you have several support options: This process keeps your data safe while changing the partitioning style. - :::note Additional notes + :::note[Additional notes] - **Partitioning is automatic**: Unraid automatically chooses the partitioning style based on drive size: - **2TB or smaller**: Always uses MBR partitioning diff --git a/docs/unraid-os/troubleshooting/troubleshooting.mdx b/docs/unraid-os/troubleshooting/troubleshooting.mdx index 187ce73a39..d858416883 100644 --- a/docs/unraid-os/troubleshooting/troubleshooting.mdx +++ b/docs/unraid-os/troubleshooting/troubleshooting.mdx @@ -2,13 +2,13 @@ Unraid systems are designed for reliability, but issues can occasionally arise. This section will guide you through resolving common problems and provide best practices for effective troubleshooting. -:::info Built-in help +:::info[Built-in help] The WebGUI offers detailed, context-sensitive help for nearly every setting. Click any field name or use the ![Help](/img/Help-icon.jpg) icon in the top right corner to access help for the entire page. ::: -:::tip Stay informed +:::tip[Stay informed] Enable notifications under ***Settings → User Preferences → Notification Settings*** to receive alerts about your system’s health. Unresolved issues can worsen if left unattended. diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx index 252115c510..c1189ca281 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-conversion-and-migration.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; When consolidating hardware, preserving legacy systems, or testing upgrades in a virtual environment, you may need to convert a physical disk or migrate an existing system into a %%virtual machine|vm%% on Unraid. This process applies to both Linux and Windows systems, enabling you to run your installation as a %%VM|vm%% within your Unraid server. -:::note Prerequisites +:::note[Prerequisites] - Your Unraid server should meet the minimum [hardware requirements for virtualization](./overview-and-system-prep.mdx#requirements) (see table below). - The source disk must be connected to your Unraid server (via SATA, USB, or as an unassigned device). @@ -152,7 +152,7 @@ To convert a physical disk to a %%VM|vm%%: You can run a Windows installation directly from a physical disk in an Unraid virtual machine (VM). This method helps migrate an existing Windows system without converting it to a virtual disk image. For a visual walkthrough, check out Spaceinvader One’s tutorial:\ [How to pass through hard drives, convert disks, and test performance in Unraid VMs (YouTube)](https://www.youtube.com/watch?v=QaB9HhpbDAI). -:::important Choosing your migration approach +:::important[Choosing your migration approach] There are two common ways to migrate a Windows installation to a %%VM|vm%% in Unraid: @@ -170,7 +170,7 @@ Choose passthrough if you want a simple migration or plan to dual-boot the disk. ::: -:::note Prerequisites +:::note[Prerequisites] - Back up your Windows installation before starting. - Have a spare USB flash drive ready for recovery tools. @@ -189,7 +189,7 @@ Moving a Windows installation to new hardware, whether physical or virtual, can Sysprep is built into Windows and eliminates unique system information, preparing Windows for different hardware. -:::note Before running sysprep +:::note[Before running sysprep] - Temporarily disable any antivirus software. - Clean up unnecessary user profiles and temporary files. @@ -303,7 +303,7 @@ If you are stuck at %%SeaBIOS|seabios%% with a "Booting from Hard Disk" message, ## Xen to KVM migration -:::info Historical Context +:::info[Historical Context] Unraid supported %%Xen|xen-hvm%% from early 6.x versions until it was deprecated in 6.2 (September 2016) and later removed entirely. This migration guide is relevant for users upgrading from very old Unraid installations (pre-2017) to modern versions. @@ -315,7 +315,7 @@ The process of migrating a %%VM|vm%% from %%Xen|xen-hvm%% to %%KVM|kvm%% varies Always create a backup of your %%Xen|xen-hvm%% virtual disk before starting this process. And test your migration on the backup to prevent data loss. -:::info Why migrate? +:::info[Why migrate?] Unraid no longer supports %%Xen|xen-hvm%% from version 6.2 onward. %%KVM|kvm%% is now mandatory for VM management, hardware passthrough, and ongoing updates. Migrating ensures your VMs remain secure and compatible with new features. @@ -405,7 +405,7 @@ To convert a Windows VM from %%Xen|xen-hvm%% to %%KVM|kvm%%, follow these steps. - Change `bus='virtio'` to `bus='ide'` in the `` tag. - Click **Update**. - :::tip Why the temporary disk? + :::tip[Why the temporary disk?] The 1MB temporary disk forces Unraid to assign the primary disk as `hda` (IDE) instead of `vda` (%%VirtIO|virtio%%), allowing Windows to boot without %%VirtIO|virtio%% drivers initially. This temporary disk will be removed after the driver installation. @@ -452,7 +452,7 @@ To convert a Windows VM from %%Xen|xen-hvm%% to %%KVM|kvm%%, follow these steps. - Change the primary disk's `bus` from `ide` to `virtio`. - Click **Update** and reboot the VM. - :::tip Driver troubleshooting + :::tip[Driver troubleshooting] If you notice errors on devices after migration: diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx index ce9867b1bb..3ce9cb4344 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx @@ -7,7 +7,7 @@ sidebar_label: VM setup Setting up a virtual machine (VM) on Unraid is a flexible way to run full operating systems - such as Windows, Linux, or other platforms - alongside your containers and native apps. Whether you want to test new software, run legacy applications, host a desktop environment, or utilize hardware passthrough for gaming or creative work, Unraid’s **VM Manager** makes the process approachable for all skill levels. -:::tip New in Unraid 7.0 +:::tip[New in Unraid 7.0] Unraid 7.x brings significant enhancements to %%virtual machines (VMs)|vm%%, including: @@ -26,7 +26,7 @@ If you haven’t done so already, please review the [Overview & system prep](./o With your system prepared and preferences set, you can create a new %%virtual machine (VM)|vm%% using the %%WebGUI|web-gui%%. -:::note Before you begin +:::note[Before you begin] - Confirm your `isos` and `domains` shares are configured and accessible. Learn more about [share management](../manage-storage/shares.mdx) here. - Upload your operating system installation ISO and, for Windows %%VMs|vm%%, the latest %%VirtIO|virtio%% drivers ISO to the `isos` share. @@ -84,7 +84,7 @@ Import/export: Unraid 7.x introduces a range of powerful enhancements to the **%%VM|vm%% Manager**, streamlining the process of running and managing %%virtual machines|vm%%. These features cater to beginners and advanced users, making deploying, customizing, and optimizing your %%VMs|vm%% simpler. -:::tip Highlights +:::tip[Highlights] - Save time with %%VM|vm%% clones, snapshots, and reusable templates - Fine-tune performance and compatibility with advanced passthrough and storage options @@ -212,7 +212,7 @@ Unraid now supports advanced GPU sharing via `VirGL` and `QXL` for Linux %%VMs|v -:::info Troubleshooting tips +:::info[Troubleshooting tips] - If your %%VM|vm%% fails to start, double-check your ISO and %%vDisk|vdisk%% paths. - For %%GPU passthrough|gpu-passthrough%%, ensure your hardware and BIOS settings support %%IOMMU|iommu%%/VT-d/AMD-Vi. @@ -261,7 +261,7 @@ After binding, bound devices will appear in the **Other PCI Devices** dropdown w %%GPU passthrough|gpu-passthrough%% allows you to assign a physical graphics card directly to a %%virtual machine (VM)|vm%%, providing near-native performance for gaming, creative work, or machine learning. -:::info Why use GPU passthrough? +:::info[Why use GPU passthrough?] - **Performance:** Direct hardware access for demanding applications. - **Compatibility:** Run graphics-intensive workloads that require a dedicated GPU. diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx index 36025bcb14..012eaac914 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; Windows is one of the most popular guest operating systems for Unraid users, especially for gaming, productivity, and support for legacy applications. Here are essential considerations for running Windows %%VM|vm%%. -:::caution Before you begin +:::caution[Before you begin] - Microsoft ended support for Windows 7 in Jan. 2020, Windows 8.1 in January 2023, and Windows 10 in October 2025. Use Windows 11 (or later) or Server 2022 (or later) for ongoing security updates. - Always test %%VM|vm%% stability before activating your Windows license. @@ -48,7 +48,7 @@ To install or update drivers: 1. Download the [latest stable VirtIO drivers ISO](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso) and save it to your Unraid `isos` share. - :::tip Verify download integrity + :::tip[Verify download integrity] Download the [CHECKSUM file](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/CHECKSUM) from the same directory to verify the ISO's integrity. This helps ensure your download is complete and hasn't been tampered with. @@ -78,7 +78,7 @@ Using Unraid 7 or later, you can automatically inject %%VirtIO|virtio%% drivers Hibernation lets you save your entire Windows %%VM|vm%% state - including open applications and documents - to disk. This allows you to power off the %%VM|vm%% without losing any work. When you resume, Windows restores everything exactly as you left it, skipping the normal boot process. This feature is handy when you need to reboot or power down your Unraid host or want to save energy while keeping your %%VM|vm%%'s state intact. -:::note Benefits of hibernation +:::note[Benefits of hibernation] - Save energy by powering down idle %%VM|vm%% without losing progress - Quickly resume work after host maintenance or updates @@ -111,7 +111,7 @@ To use hibernation reliably, you must install the %%QEMU|qemu%% %%Guest Agent|gu -:::important What if hibernation fails? +:::important[What if hibernation fails?] If your %%VM|vm%% fails to hibernate or resume properly, you may lose unsaved work or face a failed restore. Always save important data before hibernating. If issues persist, ensure the %%QEMU|qemu%% %%Guest Agent|guest-agent%% is installed and updated, and check the Windows event log for errors. @@ -254,7 +254,7 @@ If you're having trouble with HDMI audio in a Windows %%VM|vm%% that uses %%GPU Windows 11 requires TPM 2.0 and Secure Boot. Unraid's **OVMF-TPM** BIOS provides the virtual TPM support needed for these requirements. -:::important Before upgrading +:::important[Before upgrading] - Create a complete backup of your %%VM|vm%%. - Ensure that Unraid is running version 6.10 or later. diff --git a/docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx b/docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx index 98662a7b5d..7f00fe2fa8 100644 --- a/docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx +++ b/docs/unraid-os/using-unraid-to/customize-your-experience/multi-language-support.mdx @@ -18,7 +18,7 @@ You can install and use Unraid in any of the following languages: To check for additional languages or see if your language is in progress, [visit the Unraid language repositories.](https://github.com/unraid/language-templates) -:::info How Language Selection Affects Unraid +:::info[How Language Selection Affects Unraid] - **%%WebGUI|web-gui%%:** All menus, buttons, and help text are displayed in your selected language. - **Notifications:** System notifications and alerts appear in the chosen language. @@ -47,7 +47,7 @@ While every effort is made to keep translations accurate, the [English text](htt You can also use the Search bar in Community Applications to find language packs. -:::tip How to Switch Back to English +:::tip[How to Switch Back to English] To return to English, click the ![Switch back toggle](/img/switch_toggle_icon.png) **Switch back** toggle in the top-right corner of the %%WebGUI|web-gui%%. This button alternates between English and your last selected language. diff --git a/docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx b/docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx index 0b5b65a6df..d472a54efb 100644 --- a/docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx +++ b/docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx @@ -36,7 +36,7 @@ Before you install a plugin, think about these aspects: | Often open source for transparency | Requires manual maintenance and compatibility checks | | Necessary for some advanced storage or network features | | -:::important Security considerations +:::important[Security considerations] - Only install plugins from trusted sources or well-known developers. - Research each plugin before installation; check community feedback and update history. diff --git a/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx b/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx index 6e406b4c02..948fb6ff7a 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx @@ -24,7 +24,7 @@ Some users report intermittent issues with Time Machine and network shares on ma ## Creating a Time Machine share -:::caution Before you begin +:::caution[Before you begin] Ensure **%%SMB|samba%%** is enabled in the %%WebGUI|web-gui%%: diff --git a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx index 52ce571b26..a4ea426b63 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx @@ -55,7 +55,7 @@ Below are some important array configuration principles: -:::info Disk Recognition and Port Flexibility +:::info[Disk Recognition and Port Flexibility] Unraid identifies disks based on their serial numbers and sizes, not the specific SATA ports they're connected to. This means you can switch drives between different SATA ports without affecting their assignments in Unraid. This feature is particularly useful for troubleshooting hardware problems, like finding a faulty port or replacing unreliable power or SATA cables. @@ -112,7 +112,7 @@ import DocCardList from '@theme/DocCardList'; 2. Pick the slot where you want to add the disk and select the disk from the dropdown list. 3. By default, new array drives will be formatted with %%XFS|xfs%%. If you want to use %%ZFS|zfs%% or %%BTRFS|btrfs%% instead, select your preferred file system from the drop-down menu. -:::tip Hot-Swap Feature +:::tip[Hot-Swap Feature] If you're using modern Unraid-compatible hardware, you can change disks without shutting down your server. This feature, known as hot-swap, has been available in LimeTech servers since the beginning. @@ -145,7 +145,7 @@ For a more thorough approach, the pre-clear operation – available through plug **Pre-Clear** takes longer but provides a thorough test, ensuring a new disk is reliable before it becomes part of your array. -:::caution Critical Note +:::caution[Critical Note] Avoid formatting a pre-cleared disk before including it in the array, as this removes the clearance signature. @@ -155,7 +155,7 @@ Avoid formatting a pre-cleared disk before including it in the array, as this re Adding data disks is a great way to increase your Unraid array's storage space. By adding more disks, you can keep more files, applications, and backups, while still protecting your data. -:::important Important Note: +:::important[Important Note:] When adding a new data disk, it must be the same size or smaller than your current %%parity disks|parity-drives%%. If you want to use a larger disk, you'll need to replace the %%parity disks|parity-drives%% first with the larger one, then use the old %%parity disks|parity-drives%% as a data disk. @@ -247,7 +247,7 @@ When adding a new data disk, it must be the same size or smaller than your curre %%Parity disks|parity-drives%% are a helpful feature that provide an extra layer of protection for your data. They allow your storage system to recover information if a hard drive fails. While using %%parity disks|parity-drives%% is optional, it's highly recommended to keep your data safe. -:::important Requirements +:::important[Requirements] - **Single Parity:** The disk must be at least the same size as your largest data drive. - **Dual Parity:** Both %%parity disks|parity-drives%% must also be at least the size of your largest data drive, but they can be different sizes from each other. @@ -336,7 +336,7 @@ Adding a %%parity disk|parity-drives%% is similar to adding a data disk, but the -:::caution Remember +:::caution[Remember] When setting up a new data storage system, add your data disks **first**, making sure they all use a compatible file system. **After** placing your data disks, you can add a %%parity disk|parity-drives%% to protect against drive failures. @@ -374,7 +374,7 @@ If your server supports hot-swap, you do not need to power down to change disks. Once the array is back up, Unraid will start building %%parity|parity%% on the new disk. You can still access your data during this time, but keep in mind that it might be a bit slower until the process is done. Once the %%parity|parity%% build is complete, your data is protected again! -:::important Important Tips +:::important[Important Tips] - **Keep the old disk:** Don't remove the old %%parity disk|parity-drives%% until the new %%parity|parity%% build finishes. If a data disk fails during the upgrade, having the old disk might help you recover your data. @@ -407,7 +407,7 @@ When upgrading your data drive to a larger one, here are some points to keep in - **Backup the old disk:** Keep the original disk intact until the upgrade is confirmed successful. This provides a fallback option if anything goes wrong. -:::caution Warning +:::caution[Warning] Replacing drives always involves some risk. If another drive fails during the upgrade, especially with only single parity, you may experience data loss. Always check the health of your drives before beginning the process, and ensure that you keep the old drive intact until the upgrade is complete and your data is confirmed to be safe. @@ -468,7 +468,7 @@ Starting the array in Normal Mode at this point is optional. You can use it to v | **1 Disk Failure** | Data Lost | Rebuildable | Rebuildable | | **2 Disk Failures** | Data Lost | Data Lost | Rebuildable | - :::tip Tips for Safe Rebuilds + :::tip[Tips for Safe Rebuilds] - **For Single Parity:** You can only replace one disk at a time. If another disk fails during the rebuild, you could lose data. - **For Dual Parity:** You can replace one or two disks at the same time, but be cautious if more than two disks fail. @@ -590,7 +590,7 @@ If Unraid prompts you to format the new disk during the rebuild, **do not do it* - The new disk will have the same file system as the original. - If the old disk was unmountable due to file system issues, the new disk will also not be mountable. Please fix any file system issues before starting the rebuild. -:::note Additional notes +:::note[Additional notes] - The rebuild process won't change the file format of the disk; it simply restores its previous form. - Always check the health of every disk before you start a rebuild to avoid any potential issues. @@ -626,7 +626,7 @@ If Unraid prompts you to format the new disk during the rebuild, **do not do it* -:::important Prerequisites +:::important[Prerequisites] - Before starting, ensure the data drive you want to replace is disabled. If the drive has failed (shows a red indicator), it is already disabled. If the drive is healthy but you want to replace it, unassign the drive and start the array once without it to force Unraid to mark it as disabled. - If your replacement data drive is not larger than your parity drive, use the standard [Replacing a Data Drive](#replacing-faileddisabled-disks) procedure instead. @@ -634,7 +634,7 @@ If Unraid prompts you to format the new disk during the rebuild, **do not do it* ::: -:::warning Warnings +:::warning[Warnings] - Always verify the health of all drives using %%SMART reports|smart-report%% before starting a %%parity swap|parity-swap%. Attempting this procedure with another failing or unhealthy disk increases the risk of data loss. - Preclear the new disk if possible. While not required, preclearing stress-tests the drive and reduces the risk of early failure. @@ -751,7 +751,7 @@ You can choose from two methods to remove a data disk: Use the %%parity|parity%%-preserve method to remove a data disk while keeping your %%parity|parity%% valid safely. This is especially useful to avoid a full %%parity|parity%% sync after removal. Please ensure that the disk you're removing is healthy. - :::important Prerequisites + :::important[Prerequisites] Before you begin, ensure that you meet the following conditions: @@ -913,7 +913,7 @@ For convenience, you can schedule these checks to run automatically at intervals 3. **Run another check:** After you've addressed any hardware issues, running another %%parity check|parity-check%% is a good idea to ensure everything is back in order. - :::info Rebuild Time + :::info[Rebuild Time] Remember that %%parity checks|parity-check%% can take several hours, depending on the size of your disks and the activity level of your system. For the best results, schedule these checks during times of low system usage. @@ -1169,7 +1169,7 @@ Unraid provides various write modes for managing array operations, each with its -:::info Automated Solutions +:::info[Automated Solutions] - The **Auto** mode (a future feature) will engage turbo write only when all drives are already spinning. - Community plugins (search for "Turbo Write" in the Apps tab) may offer enhanced automation or scheduling options. @@ -1186,7 +1186,7 @@ To change Write Mode: - **Auto** (future feature) 4. Click **Apply** to confirm your choice. -:::important Quick recap +:::important[Quick recap] - Use **Turbo Write** when you need speed, but be aware of increased power consumption and drive spin-up. - Utilize **Cache Write** for optimal performance, particularly with SSD or NVMe drives. @@ -1206,7 +1206,7 @@ When using Unraid, the speed at which you can read files is mainly determined by - **Typical SATA SSD:** 400–550 MB/s - **NVMe SSD (in a pool):** 250–7,000 MB/s (PCIe generation and network/PCIe limitations apply; e.g., 10GbE network caps at \~1,100 MB/s) -:::note Special cases +:::note[Special cases] - If a disk is disabled and its data is being reconstructed, Unraid will use the remaining drives along with parity information to recreate the data. During this process, the read speed may slow down to 30–60 MB/s or even lower, depending on the slowest drive in your system. - Any ongoing operations in the array, such as a %%parity check|parity-check%% or rebuilding a drive, can also affect read performance. This is due to increased movement of the drive heads and overall contention for resources. @@ -1308,7 +1308,7 @@ If your array won't start, follow these steps to identify and fix common problem 2. Click **Get Trial Key** or **Purchase Key**. 3. Install the key by returning to **Registration**, pasting in the field, and clicking the **Install Key** button. - :::note Trial vs. Paid Licenses + :::note[Trial vs. Paid Licenses] - **Trial License:** Full Unraid access for 30 days, just like the higher license tiers. You can use unlimited storage devices, but you'll need an internet connection to start it up. [Start a new trial here.](https://unraid.net/getting-started) @@ -1322,7 +1322,7 @@ If your array won't start, follow these steps to identify and fix common problem ::: - :::caution Blacklisted USB flash devices + :::caution[Blacklisted USB flash devices] If your server is online and your trial hasn't run out, your USB flash drive might have a %%GUID|guid%% that can't register a key. This can happen if the %%GUID|guid%% isn't unique or has already registered by someone else. Using an SD card reader via USB can also cause this issue since it often has a generic %%GUID|guid%%. If your USB flash drive is **blacklisted**, it can't be used anymore, and you'll need to find a different device for your Unraid Server OS installation. @@ -1379,7 +1379,7 @@ Rebuilding disks puts a lot of stress on all drives, which increases the chance ::: -:::info Rebuild Time +:::info[Rebuild Time] Be prepared for the rebuild process to take several hours. The time can vary based on disk size and how busy your system is. Larger disks and busy systems may take longer. diff --git a/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx b/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx index 37627d7a3c..bfb0dbb037 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx @@ -17,7 +17,7 @@ In Unraid, a %%cache pool|cache-pool%% is a collection of one or more drives, ty 4. **Flexible and dedicated storage:** With multiple %%cache pools|cache-pool%%, you can assign specific pools for different tasks. For instance, you could have one pool dedicated to downloads and another for %%virtual machines|vm%%, reducing competition for resources and boosting efficiency. -:::info Keep in Mind +:::info[Keep in Mind] - **Multiple pools:** You can create and name different %%cache pools|cache-pool%%, tailoring them to match your specific needs. - **SSD vs. HDD:** SSDs are great for speed, while you can use HDDs for large, sequential data workloads. Additionally, HDDs can help prolong the lifespan of your SSDs. @@ -193,7 +193,7 @@ Removing a disk from a %%BTRFS|btrfs%% or %%ZFS|zfs%% multi-device %%cache pool| - :::note Before you start + :::note[Before you start] - You can only remove one drive at a time using the GUI. - Make sure your pool is using a redundant %%RAID|raid%% profile (like %%RAID 1|raid1%% for both data and metadata). @@ -207,7 +207,7 @@ Removing a disk from a %%BTRFS|btrfs%% or %%ZFS|zfs%% multi-device %%cache pool| 3. **Start the %%array|array%%**: Restart the %%array|array%% to apply the changes. 4. **Verify removal**: Click on the first pool device in the **Main** tab, then check **Balance Status** (for %%BTRFS|btrfs%%) or **zpool status** (for %%ZFS|zfs%%) to confirm the device was correctly removed. - :::note Timing + :::note[Timing] Keep in mind that removing a drive and rebalancing the pool may take several hours, depending on how much data you have and your device speeds. @@ -219,7 +219,7 @@ Removing a disk from a %%BTRFS|btrfs%% or %%ZFS|zfs%% multi-device %%cache pool| If you're comfortable with the command line, this method gives you more control and can be useful if the %%WebGUI|web-gui%% option isn't available. For more information on using the command line interface, see [Command line interface](../../system-administration/advanced-tools/command-line-interface.mdx). - :::note Before you start + :::note[Before you start] - Ensure that your pool's %%RAID|raid%% profile allows device removal; you can't remove a device from a 2-device %%RAID 1|raid1%% pool without changing it to a single profile first. - Check that remaining devices will have enough space for your data. @@ -258,7 +258,7 @@ Removing a disk from a %%BTRFS|btrfs%% or %%ZFS|zfs%% multi-device %%cache pool| However, keep in mind that the removal will still occur one at a time. - :::note Timing + :::note[Timing] Similar to the %%WebGUI|web-gui%% method, removing devices and rebalancing may take several hours depending on data volume and device speed. @@ -333,7 +333,7 @@ For advanced %%BTRFS|btrfs%% configuration details, refer to the [BTRFS wiki](ht Replacing a disk in your %%cache pool|cache-pool%% is an important task that helps maintain the performance and reliability of your storage system. -:::note Prerequisites +:::note[Prerequisites] - **Check your pool configuration:** Make sure your pool is set up with a redundant %%RAID|raid%% profile, like %%RAID 1|raid1%%. You can do this by going to ***Main → Pool → Balance Status*** (for %%BTRFS|btrfs%%) or ZFS pool status (for %%ZFS|zfs%%) in your management interface. - **Choose the right replacement disk:** The new disk must be the same size or larger than the one you're replacing. @@ -351,7 +351,7 @@ To replace a disk in a pool: 6. **Start the %%array|array%%**: Click the **Start** button to begin the process of integrating the new disk into the %%array|array%%. 7. **Monitor the rebuild**: The system will automatically start reconstructing the data onto the new disk. You can keep an eye on the progress in the %%WebGUI|web-gui%%. -:::important Timing +:::important[Timing] Rebuilding can take some time, depending on the size of the disk and the current load on your system. For example, rebuilding a 4TB SSD in a %%RAID 1|raid1%% setup may take approximately 3-6 hours. It's a good idea to plan this when you can allow the system to work uninterrupted. @@ -363,7 +363,7 @@ Rebuilding can take some time, depending on the size of the disk and the current Setting a minimum free space for your %%cache pool|cache-pool%% can provide better control over file placement, especially when dealing with large files like high-resolution videos. This setting helps Unraid know when to stop writing to the pool and start writing directly to the larger storage %%array|array%%, avoiding interruptions or data corruption. -:::tip Example +:::tip[Example] If you often download files around 10 GB, set the minimum free space to at least 10 GB, but ideally 20 GB to allow for adjustments. @@ -379,13 +379,13 @@ You can access Minimum free space by clicking on the pool name in the **Main** t - If set to use a %%cache pool|cache-pool%% exclusively (no **Secondary storage**), this setting is not applied. - If set to use only the %%array|array%% as **Primary storage**, files go straight to the %%array|array%%. -:::tip Use case example +:::tip[Use case example] Media share has the floor set to 20GB, which is appropriate for the files in that share. However, if you also use the pool for a VM and want to leave a cushion in case the vdisk grows, you could set the pool floor to 50GB. This way, any transfer to the Media share after the pool has less than 50GB free would go directly to the array. ::: -:::tip Best practice +:::tip[Best practice] Set the minimum free space to at least the size of the largest file you expect, preferably double that size. For example, if your largest file is 30 GB, set the minimum to 60 GB. @@ -411,7 +411,7 @@ Always disable Docker and %%VM|vm%% services before moving files with the %%Move - :::info Common use case + :::info[Common use case] Moving files off the %%cache pool|cache-pool%% to the %%array|array%% before performing maintenance or upgrades to ensure your data is safe. @@ -427,7 +427,7 @@ Always disable Docker and %%VM|vm%% services before moving files with the %%Move - :::info Common use case + :::info[Common use case] Moving files back to the %%cache pool|cache-pool%% after maintenance or when you've added a new cache device to improve performance. @@ -482,7 +482,7 @@ Unraid allows you to create and manage up to 35 separate storage pools, each wit | Project/Team isolation | Separate pools for each team/project | Reduces resource conflicts | | Snapshots and backup targets | %%ZFS\|zfs%% pool, %%RAIDZ1\|raidz1%%/%%RAIDZ2\|raidz2%% (multi-device) | Supports native snapshots and backups | -:::info Supported File Systems +:::info[Supported File Systems] - %%BTRFS|btrfs%%: Best for multi-device pools (supports %%RAID 0|raid0%%, %%RAID 1|raid1%%, %%RAID 10|raid10%%, %%RAID 5|raid5%%, %%RAID 6|raid6%%). - %%ZFS|zfs%%: Excellent for both single and multi-device pools (Unraid 6.12+), with mature support for %%RAIDZ1|raidz1%% and %%RAIDZ2|raidz2%%. For advanced ZFS features and configuration, see [ZFS storage](../../advanced-configurations/optimize-storage/zfs-storage.mdx). @@ -500,7 +500,7 @@ When accessing a [%%user share|user-share%%](./shares.mdx) from multiple pools a Unraid doesn't allow direct file movement between pools through the %%WebGUI|web-gui%%, but you can do it using the %%Mover|mover%% tool or via command line. -:::note Remember +:::note[Remember] Any the files belong to a Docker container and/or %%VM|vm%% then the services must be disabled for the files to be moved successfully. @@ -520,7 +520,7 @@ Any the files belong to a Docker container and/or %%VM|vm%% then the services mu - In the **Main** tab, click **Move Now** again. Files will move from the %%array|array%% to pool2. 4. **Re-enable Docker and %%VM|vm%% services** (if needed). - :::note Timing + :::note[Timing] Moving large data sets can take hours, depending on file size and device speeds. diff --git a/docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx b/docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx index b6246c083a..06e19fc980 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/file-systems.mdx @@ -49,7 +49,7 @@ import TabItem from '@theme/TabItem'; -:::note Additional Notes +:::note[Additional Notes] - Mixing different file system types in your Unraid system is perfectly acceptable; the Unraid %%parity|parity%% system works independently of the file system used. - Always format and partition drives within Unraid to ensure compatibility. @@ -59,7 +59,7 @@ import TabItem from '@theme/TabItem'; ::: -:::tip Still need help choosing? +:::tip[Still need help choosing?] - **For array drives:** %%XFS|xfs%% is generally the best choice for most users. - **For high-performance or advanced features:** Choose %%ZFS|zfs%% or %%BTRFS|btrfs%% for %%cache pools|cache-pool%% or multi-device setups. @@ -168,7 +168,7 @@ To safely convert to a new file system type: 3. **Copy your data back**: (Optional) Depending on where you moved the files, you may want to move them back to the newly formatted drive. 4. **Repeat as needed**: If you have more than one drive to convert, repeat these steps for each drive, transferring data as needed. -:::note Timing +:::note[Timing] The process can take several hours, depending on the amount of data and the speed of your drives. Most of the time is spent copying files, which can run unattended. @@ -241,7 +241,7 @@ To restore data and settings: 13. **Re-enable Docker and %%VM|vm%% services**. 14. **Start the array**. -:::note Timing +:::note[Timing] The time it takes to move data with the %%Mover|mover%% and format the drive can vary from several minutes to several hours, depending on the amount of data and the speed of the drive. @@ -272,7 +272,7 @@ Let’s break down what each operation does and when to use them: 2. **Add parameters (optional)**: Optionally, add parameters for advanced use (refer to Unraid Help for details). 3. **Start the process**: Click **Start** to begin the process. - :::note Timing + :::note[Timing] Balance operations can take a few minutes to several hours, depending on the pool size and amount of data. @@ -300,7 +300,7 @@ Let’s break down what each operation does and when to use them: 1. **Access the pool**: In the %%WebGUI|web-gui%%, click on the pool in the **Main** tab and select **Scrub**. 2. **Start the process**: Click **Start** to initiate the process. - :::note Timing + :::note[Timing] Scrub operations are usually quicker than a full disk scan because they only check allocated data. Based on pool size and usage, expect this to take anywhere from a few minutes to a few hours. @@ -384,7 +384,7 @@ If a drive is both unmountable and disabled (red 'x'), first run the file system Fixing the file system typically takes less time than rebuilding the drive, allowing you to access your data without losing anything. Remember, rebuilding a drive does **not** fix file system issues; it merely ensures that the physical drive matches the emulated one, carrying over any existing problems. -:::important Why is parity not enough? +:::important[Why is parity not enough?] While %%parity|parity%% helps recover a failed drive, it cannot fix file system problems. If the file system is corrupted, %%parity|parity%% will simply replicate that corruption to the new drive. @@ -395,7 +395,7 @@ If you’re unsure: ::: -:::note Just to reiterate +:::note[Just to reiterate] - Only format unmountable drives if they are brand new or if you want to erase all data. - Use the file system check/repair for fixing corrupt files; don’t rely on %%parity|parity%% to solve these issues. @@ -550,7 +550,7 @@ This automated system eliminates the need for users to manually enter repair opt If a check of your file system finds errors, you might need to run a repair to get access to your data again. Repairs typically take less time than a full rebuild, but it's important to read the output carefully and reach out for help on the [forums](https://forums.unraid.net/) if you're unsure about anything. -:::note Timing +:::note[Timing] Repairs can take anywhere from several minutes to several hours, especially for larger or heavily corrupted file systems. Progress might seem slow, but you can check on the activity by looking at the read/write statistics on the Main page. @@ -610,7 +610,7 @@ If you're uncertain about the output, copy and share it on the [Unraid forums](h - To perform a %%scrub|scrub%% (which detects and repairs many errors automatically), start the %%array|array%% in **Normal mode** and run: `btrfs scrub start /mnt/diskX`. - For a full repair, start the %%array|array%% in **%%Maintenance Mode|maintenance-mode%%** and run: `btrfs check --repair /dev/mdXp1`. Only use `--repair` if advised by the [forums](https://forums.unraid.net/) or documentation, as it can sometimes lead to further issues. - :::caution Use `--repair` with caution + :::caution[Use `--repair` with caution] The `--repair` option can sometimes cause data loss or make corruption worse if used incorrectly. Only use it when: @@ -649,7 +649,7 @@ If you're uncertain about the output, copy and share it on the [Unraid forums](h -:::info After the repair +:::info[After the repair] - Stop and restart the %%array|array%% in **Normal mode**. - The drive should now mount and be accessible. diff --git a/docs/unraid-os/using-unraid-to/manage-storage/shares.mdx b/docs/unraid-os/using-unraid-to/manage-storage/shares.mdx index 07a82f9ecd..2bbf0cea65 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/shares.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/shares.mdx @@ -56,7 +56,7 @@ The deprecated `/mnt/user0` mount point (which excludes %%pool|cache-pool%% file The physical drive that stores a file is determined by share settings such as **%%Allocation Method|allocation-method%%**, **%%Included/Excluded Disks|included-or-excluded-disks%%**, and **%%Split Level|split-level%%**. Changes to these settings will affect only new files; existing files will remain untouched unless moved manually. -:::caution Critical +:::caution[Critical] **Do not mix User Shares and Disk Shares** @@ -76,7 +76,7 @@ To add a share: 2. **Choose a share name:** Pick a unique name for your share, like `Media` or `Documents`. -:::important Share names +:::important[Share names] Even though network shares (%%SMB|samba%%) don’t care about capitalization (e.g., `MEDIA` is the same as `media`), Linux file systems do. Avoid using names that are identical but only differ in case to prevent issues. @@ -164,7 +164,7 @@ For shares containing data: -:::note Alternative Method +:::note[Alternative Method] If you can access the share over the network: @@ -298,7 +298,7 @@ import TabItem from '@theme/TabItem'; Unraid provides a straightforward way to manage file placement between **%%cache pools|cache-pool%%** and the **%%array|array%%**, allowing you to optimize performance and manage your data effectively. The key is to set up your share settings based on your preferred data flow and let the **%%Mover|mover%%** handle file transfers automatically according to its schedule. -:::tip Scheduling the Mover +:::tip[Scheduling the Mover] You can configure the [**%%Mover|mover%%** schedule](../../getting-started/set-up-unraid/customize-unraid-settings.mdx#scheduler) by going to **Settings → Scheduler → Mover Settings**. Running it automatically during off-peak hours helps move files between the %%cache|cache%% and %%array|array%% without requiring manual action. @@ -348,13 +348,13 @@ You can configure the [**%%Mover|mover%%** schedule](../../getting-started/set-u -:::tip Enabling Mover logging for troubleshooting +:::tip[Enabling Mover logging for troubleshooting] If you run into issues with file movement, you can enable **Mover logging** through the ***Settings → Scheduler → Mover Settings*** page. This logs every file moved and can be viewed in ***Tools → System Log***. ::: -:::caution Critical steps for both directions +:::caution[Critical steps for both directions] - Make sure your %%parity|parity%% is valid before moving files from the %%array|array%% to the %%cache|cache%%. - If dealing with large datasets, keep an eye on %%Mover|mover%% activity via the logs. @@ -601,7 +601,7 @@ For security, it's best to keep your shares in *Private* mode and only grant acc ### Disk share guidelines -:::danger Important Reminder +:::danger[Important Reminder] **Never copy files directly between a user share and a disk share** if their folder names are the same. This could lead to files being corrupted or deleted, resulting in permanent data loss. ::: diff --git a/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx b/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx index 73ae06b35e..8d6bde24e9 100644 --- a/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx +++ b/docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx @@ -74,7 +74,7 @@ Before installing, consider backing up your flash drive to protect your configur Keep the installation window open until the process is fully completed. - :::tip Security tip + :::tip[Security tip] Before you install, take a moment to read the application's description. Check the developer's reputation and ensure the source repository is trustworthy. It’s best to choose applications from well-known developers or those with active support threads. Always be cautious about granting access to your %%array|array%%, %%cache pool|cache-pool%%, or any sensitive data. Learn more about [security fundamentals](../../system-administration/secure-your-server/security-fundamentals.mdx). @@ -116,7 +116,7 @@ If you’re using Docker containers and plugins, you'll find that most come with - **Plugins Tab**: On the **Plugins** tab, each plugin will have a **Support Thread** link right in its summary for quick access. -:::tip Support preferences +:::tip[Support preferences] When accessing support options, look for these dropdown options: diff --git a/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx b/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx index e6a2102e1b..51be3068c2 100644 --- a/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx +++ b/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; # Managing & customizing containers -:::caution Disclaimer +:::caution[Disclaimer] This page is written to help users of all skill levels make the most out of Docker containers on Unraid OS. The tips and best practices come from the Unraid team, who ensure they are tailored to most users' needs. However, keep in mind that Docker is constantly evolving, so for the most up-to-date features, advanced configurations, or troubleshooting issues that go beyond what Unraid covers, it's always a good idea to check the [official Docker documentation](https://docs.docker.com/). @@ -35,7 +35,7 @@ Before customizing a Docker container in Unraid, it’s helpful to understand th ::: - :::caution Wi-Fi and Docker Networking Limitations + :::caution[Wi-Fi and Docker Networking Limitations] Docker has a limitation that prevents it from participating in two networks that share the same subnet. If you switch between a wired and a wireless connection, you will need to restart Docker and reconfigure all existing containers to use the new interface. This [network configuration](../../system-administration/secure-your-server/securing-your-connection.mdx) change requires container reconfiguration. @@ -51,7 +51,7 @@ Before customizing a Docker container in Unraid, it’s helpful to understand th - **Host path:** The directory on your Unraid server (e.g., `/mnt/user/appdata/myapp`). - **Access mode:** Controls permissions - read-only or read/write. Use the most restrictive mode that still allows the container to function. - :::tip Best practice + :::tip[Best practice] Store application data (settings, libraries, etc.) outside the container, typically in the `appdata` %%user share|user-share%%. This [share management](../manage-storage/shares.mdx) approach keeps your data safe during updates or reinstalls. @@ -103,7 +103,7 @@ Before customizing a Docker container in Unraid, it’s helpful to understand th - Many container templates come with common environment variables that are already set, but you can always add more if needed. - Be sure to check the specific application’s documentation to know which environment variables are available and which values are valid. - :::info Examples of environment variables + :::info[Examples of environment variables] - `TZ=America/New_York`: This sets the container's time zone. - `PUID=99` and `PGID=100`: These set the user and group IDs for file permissions. @@ -138,7 +138,7 @@ After reviewing your configuration settings in the container template: Some containers depend on others to function correctly. For example, an application might need a database container running first, or a service might require a [%%VPN|vpn-tunnel%% container](../../system-administration/secure-your-server/tailscale.mdx) to be active before it starts. -:::important Plan your startup +:::important[Plan your startup] - Identify containers that provide core services (like databases, %%VPNs|vpn-tunnel%%, or storage gateways). - Ensure dependent containers are started only after their prerequisites are running and ready. @@ -257,7 +257,7 @@ Here are some examples showing common path mapping configurations that users fre Host path: `/mnt/user/torrents` → Container path: `/torrents`\ Reference `/downloads` or `/torrents` in the application as needed. -:::important Best practice +:::important[Best practice] Always use the most restrictive [access mode](../manage-storage/shares.mdx) (read-only or read/write) that allows your container to function properly. diff --git a/docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx b/docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx index 829392e8ac..4d3373c4a7 100644 --- a/docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx +++ b/docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx @@ -44,7 +44,7 @@ The Community Applications plugin is the easiest and most popular way to discove For a complete guide to installing and using the Community Applications plugin, including advanced features and troubleshooting, check out [Community Applications](./community-applications.mdx). -:::note Notes and Support +:::note[Notes and Support] - Most containers in Community Applications are maintained by the broader Unraid and Docker communities. - For assistance with a specific container, check its documentation or support thread linked in the **Apps** tab. From d4c50fe1c1cb075ed6c099f48fbbeb7b75b56fab Mon Sep 17 00:00:00 2001 From: ljm42 Date: Tue, 23 Sep 2025 11:40:45 -0700 Subject: [PATCH 2/4] chore: CodeRabbit suggestions --- .../maintain-and-update/upgrading-unraid.mdx | 4 ++-- .../using-unraid-to/create-virtual-machines/vm-setup.mdx | 2 +- .../using-unraid-to/manage-storage/array-configuration.mdx | 5 +++-- .../unraid-os/using-unraid-to/manage-storage/cache-pools.mdx | 2 +- .../managing-and-customizing-containers.mdx | 2 +- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx b/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx index 398ad898f6..e190b4b381 100644 --- a/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx +++ b/docs/unraid-os/system-administration/maintain-and-update/upgrading-unraid.mdx @@ -62,11 +62,11 @@ Before you start upgrading, make sure to create a complete backup of your USB fl :::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. ::: diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx index 3ce9cb4344..9656c26ad6 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/vm-setup.mdx @@ -265,7 +265,7 @@ After binding, bound devices will appear in the **Other PCI Devices** dropdown w - **Performance:** Direct hardware access for demanding applications. - **Compatibility:** Run graphics-intensive workloads that require a dedicated GPU. -- **Flexibility:** Transform your unraid server into a multi-purpose workstation. +- **Flexibility:** Transform your Unraid server into a multi-purpose workstation. ::: diff --git a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx index a4ea426b63..4eef0c4dba 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx @@ -636,7 +636,7 @@ If Unraid prompts you to format the new disk during the rebuild, **do not do it* :::warning[Warnings] -- Always verify the health of all drives using %%SMART reports|smart-report%% before starting a %%parity swap|parity-swap%. Attempting this procedure with another failing or unhealthy disk increases the risk of data loss. +- Always verify the health of all drives using %%SMART reports|smart-report%% before starting a %%parity swap|parity-swap%%. Attempting this procedure with another failing or unhealthy disk increases the risk of data loss. - Preclear the new disk if possible. While not required, preclearing stress-tests the drive and reduces the risk of early failure. - Correctly identify all drives before beginning. Note the model numbers and last four characters of each serial number to avoid mistakes during assignment. @@ -1047,7 +1047,8 @@ To reset your array configuration: When you see the **Start** button, there is a checkbox labeled **Parity is Valid**. Only check this box if you are certain it is correct or if an experienced Unraid user has advised you to do so during recovery. Incorrectly checking this option can lead to data loss. Do not use **New Config** if your goal is to rebuild a disk. Performing a New Config clears the array history required for a rebuild, and Unraid will not offer to rebuild the disk afterward. Follow the disk rebuild procedure instead. -:::: + +::: #### Undoing a reset diff --git a/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx b/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx index bfb0dbb037..31a0b600a3 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/cache-pools.mdx @@ -502,7 +502,7 @@ Unraid doesn't allow direct file movement between pools through the %%WebGUI|web :::note[Remember] -Any the files belong to a Docker container and/or %%VM|vm%% then the services must be disabled for the files to be moved successfully. +If any of the files belong to a Docker container and/or %%VM|vm%%, the services must be disabled for the files to be moved successfully. ::: diff --git a/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx b/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx index 51be3068c2..3d1028f498 100644 --- a/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx +++ b/docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx @@ -350,7 +350,7 @@ Cron expressions enable flexible scheduling beyond the built-in options. For exa To view the logs for a container (helpful for troubleshooting): ``` - docker logs "container-name + docker logs "container-name" ``` This displays recent log output for the specified container. From 2a8eeea095a89ec2027c64e413297cf78aa1d11a Mon Sep 17 00:00:00 2001 From: ljm42 Date: Tue, 23 Sep 2025 11:47:56 -0700 Subject: [PATCH 3/4] chore: fix admonition markdown --- docs/unraid-connect/automated-flash-backup.mdx | 2 +- docs/unraid-connect/remote-access.mdx | 2 +- .../common-issues/boot-and-startup-failures.mdx | 2 +- .../common-issues/system-crashes-and-stability.mdx | 8 ++++---- .../troubleshooting/common-issues/unclean-shutdowns.mdx | 4 ++-- .../diagnostics/capture-diagnostics-and-logs.mdx | 4 ++-- docs/unraid-os/troubleshooting/licensing-faq.mdx | 2 +- .../create-virtual-machines/overview-and-system-prep.mdx | 8 ++++---- .../create-virtual-machines/unraid-as-a-vm.mdx | 4 ++-- .../create-virtual-machines/windows-on-a-vm.mdx | 2 +- .../using-unraid-to/manage-storage/apple-time-machine.mdx | 4 ++-- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/unraid-connect/automated-flash-backup.mdx b/docs/unraid-connect/automated-flash-backup.mdx index ce0cf5cf87..996519dd29 100644 --- a/docs/unraid-connect/automated-flash-backup.mdx +++ b/docs/unraid-connect/automated-flash-backup.mdx @@ -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. diff --git a/docs/unraid-connect/remote-access.mdx b/docs/unraid-connect/remote-access.mdx index e8d8f2f5b0..224c5ebdc2 100644 --- a/docs/unraid-connect/remote-access.mdx +++ b/docs/unraid-connect/remote-access.mdx @@ -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. diff --git a/docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx b/docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx index cdf996000d..0846131d91 100644 --- a/docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/boot-and-startup-failures.mdx @@ -170,7 +170,7 @@ This procedure helps you restore your array configuration when you've lost your 7. Start the %%array|array%% to commit the drive assignments. 8. If the %%parity|parity%% is valid, check the box for ***Parity is Already Valid***. If not, allow the %%parity|parity%% to rebuild. -:::warning Multiple parity drives +:::warning[Multiple parity drives] If you have multiple %%parity drives|parity-drives%% and had to identify them based on which drives were unmountable, **do not** use the **Parity is Already Valid** option. There's a 50:50 chance of getting the assignments wrong, and if you do, your %%array|array%% may appear protected but actually isn't. Always allow parity to rebuild in this scenario to ensure proper protection. diff --git a/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx b/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx index 4465d76e27..8892393443 100644 --- a/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx @@ -35,7 +35,7 @@ To test your RAM: 3. Monitor for any error messages or failed tests. 4. For the latest version with enhanced DDR4/DDR5 compatibility, download from [memtest.org](https://www.memtest86.com/). -:::note Other RAM testing tools +:::note[Other RAM testing tools] - [**Karhu RAM Test**](https://www.karhusoftware.com/): A paid but highly effective Windows-based tool that can detect errors faster than traditional methods, with detection rates of 95.67% within 30 minutes (ideal for DDR5 systems) - [**HCI MemTest**](https://hcidesign.com/memtest/): Popular, free Windows-based tester @@ -43,7 +43,7 @@ To test your RAM: ::: -:::important If you find RAM errors +:::important[If you find RAM errors] If Memtest86+ shows errors, try reseating the RAM modules and rerunning the test. Test each RAM stick individually to pinpoint faulty modules. Refer to your motherboard documentation for supported RAM speeds and configurations, and avoid mixing different RAM brands or speeds to minimize compatibility issues. @@ -53,7 +53,7 @@ If Memtest86+ shows errors, try reseating the RAM modules and rerunning the test RAM overclocking can significantly impact system stability. Many users want to run their RAM at the highest speed specified by the manufacturer, but motherboard and CPU combinations often have maximum reliable RAM speeds that are lower than what the RAM is rated for. -:::caution RAM overclocking risks and recommendations +:::caution[RAM overclocking risks and recommendations] **Purchasing:** When possible, always purchase RAM that is listed on your motherboard's QVL (Qualified Vendor List), not from the RAM manufacturer's QVL. This ensures better compatibility and stability. @@ -218,7 +218,7 @@ System stability typically depends on: Keeping your system firmware current helps prevent unexpected crashes and unlocks new hardware features. - :::tip Recommendations + :::tip[Recommendations] - Use manufacturer utilities for risk-free updates, such as [ASUS Armoury Crate](https://www.asus.com/supportonly/armoury%20crate/helpdesk_download/), [Gigabyte @BIOS](https://www.gigabyte.com/Support/Consumer/Download), or [MSI Center](https://www.msi.com/Landing/MSI-Center). - Check your motherboard's BIOS settings for automatic update options if available. diff --git a/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx b/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx index ad68ba5b20..fd228cbc25 100644 --- a/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; An unclean shutdown happens when Unraid detects that the %%array|array%% was not properly stopped before the system powered off. This situation can trigger an automatic %%parity check|parity-check%% during the next boot to ensure data integrity. -:::important Recommendations to prevent unclean shutdowns +:::important[Recommendations to prevent unclean shutdowns] Taking some proactive steps can help you avoid or identify unclean shutdowns: @@ -21,7 +21,7 @@ Taking some proactive steps can help you avoid or identify unclean shutdowns: ::: -:::tip UPS configuration best practices +:::tip[UPS configuration best practices] A well-configured UPS is your best defense against unclean shutdowns caused by power loss. diff --git a/docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx b/docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx index ec6f063edf..0fb8ac563d 100644 --- a/docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx +++ b/docs/unraid-os/troubleshooting/diagnostics/capture-diagnostics-and-logs.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; When you have issues with your Unraid server, gathering detailed information is crucial for effective troubleshooting. This information helps others provide accurate and timely assistance, especially when you post in forums. -:::info Diagnostics include... +:::info[Diagnostics include...] The diagnostics zip file contains several anonymized text files that create a detailed snapshot of your Unraid system, including: @@ -55,7 +55,7 @@ When your system shuts down gracefully, the session log is saved automatically t You can use built-in Linux tools to evaluate the read performance of your hard drives. This is helpful when diagnosing slow %%parity|parity%% syncs, sluggish disk responses, or mismatched speeds among drives in an %%array|array%% or %%cache|cache%%. -:::important When and why to test drive speed +:::important[When and why to test drive speed] Consider running disk read benchmarks if you experience: diff --git a/docs/unraid-os/troubleshooting/licensing-faq.mdx b/docs/unraid-os/troubleshooting/licensing-faq.mdx index 6a0bc4db24..f2757c544d 100644 --- a/docs/unraid-os/troubleshooting/licensing-faq.mdx +++ b/docs/unraid-os/troubleshooting/licensing-faq.mdx @@ -89,7 +89,7 @@ This page contains frequently asked questions about Unraid OS licensing. For gen ::: - :::note Instructional Video + :::note[Instructional Video] Watch the [Activation Code Instructional Video](https://www.loom.com/share/3ceb40440240474aaa80a0b7e3e69cb2) for step-by-step guidance. diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx index 304b4d6ff2..3c4768db14 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx @@ -69,7 +69,7 @@ To run %%VMs|vm%% on Unraid, your system must meet the following requirements: | Network | Gigabit Ethernet (PCIe recommended) | 2.5G/10G Ethernet for demanding workloads | | GPU (optional) | Modern NVIDIA RTX (recommended) or AMD Radeon RX | RTX 3000/4000 series (NVIDIA recommended for better passthrough compatibility) | -:::tip GPU passthrough compatibility +:::tip[GPU passthrough compatibility] NVIDIA GPUs are **generally recommended** for %%VM|vm%% passthrough due to better compatibility and reliability. AMD GPUs can be more challenging to pass through, and some newer models (including RX 7000/9000 series) may not work reliably or at all with %%VMs|vm%%. If you're planning to use %%GPU passthrough|gpu-passthrough%%, consider NVIDIA options for the best experience. @@ -115,7 +115,7 @@ Your motherboard BIOS must enable Hardware-assisted virtualization and %%IOMMU|i -:::important How to check support +:::important[How to check support] In the %%WebGUI|web-gui%%, click **Info** in the top menu. @@ -147,7 +147,7 @@ Passing a GPU to a %%VM|vm%% allows for near-native graphics performance, making -:::tip General tips +:::tip[General tips] - Use %%OVMF|ovmf%% (%%UEFI|uefi%%) for %%VMs|vm%% with modern GPUs. - Always use the latest Unraid version for improved hardware support. @@ -155,7 +155,7 @@ Passing a GPU to a %%VM|vm%% allows for near-native graphics performance, making ::: -:::info Always changing +:::info[Always changing] Hardware and driver compatibility changes rapidly. Before purchasing a GPU for passthrough, check the [Unraid forums](https://forums.unraid.net/) and vendor documentation for up-to-date reports and user experiences. diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx index 5de880988f..a76ef99bff 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/unraid-as-a-vm.mdx @@ -14,7 +14,7 @@ Running Unraid as a virtual machine on your primary Unraid server can be very he - Evaluate new Unraid releases before upgrading your main system. - Create isolated environments for troubleshooting or training. -:::caution Important considerations +:::caution[Important considerations] - Lime Technology does not officially support this configuration for production data. - Virtualization introduces some overhead; expect reduced performance compared to running directly on hardware. @@ -22,7 +22,7 @@ Running Unraid as a virtual machine on your primary Unraid server can be very he ::: -:::note Prerequisites +:::note[Prerequisites] - A valid Unraid license key for the %%VM|vm%% - A dedicated USB flash drive (use a different manufacturer than your host's boot drive) diff --git a/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx b/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx index 012eaac914..d03b6a2442 100644 --- a/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx +++ b/docs/unraid-os/using-unraid-to/create-virtual-machines/windows-on-a-vm.mdx @@ -293,7 +293,7 @@ To add TPM support: ## Expanding Windows VM vDisk partitions -:::caution data loss risk +:::caution[Data loss risk] Expanding or modifying %%vDisk|vdisk%% and partition layouts can lead to irreversible data loss if not done carefully. Always create a full backup or snapshot of your %%VM|vm%% before proceeding. diff --git a/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx b/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx index 948fb6ff7a..d125866320 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/apple-time-machine.mdx @@ -10,13 +10,13 @@ import TabItem from '@theme/TabItem'; Apple’s Time Machine is a backup tool that comes with every Mac. It makes it easy to protect your files, applications, and system settings by automatically backing them up. By connecting Time Machine to your Unraid server, you can store these backups securely on your own hardware. This setup not only gives you more control but also allows for easier scalability and added peace of mind. -:::note macOS compatibility +:::note[macOS compatibility] This guide applies to macOS Ventura (13.x), Sonoma (14.x), and Sequoia (15.x) versions. Some features, such as %%SMB|samba%% enhancements and Time Machine support over %%SMB|samba%%, require macOS versions that support these protocols. For the best results, keep your Mac updated to the latest version of macOS that is compatible with your hardware. -:::caution macOS Sequoia (15.x) considerations +:::caution[macOS Sequoia (15.x) considerations] Some users report intermittent issues with Time Machine and network shares on macOS Sequoia. If you experience backup failures, consider using the [Time Machine Docker container](https://unraid.net/community/apps?q=time+machine#r) as an alternative. From a9289a0c3d6445960c6f33c236954b84ebce77ff Mon Sep 17 00:00:00 2001 From: ljm42 Date: Tue, 23 Sep 2025 12:23:33 -0700 Subject: [PATCH 4/4] chore: CodeRabbit suggestions --- .../common-issues/system-crashes-and-stability.mdx | 3 ++- .../troubleshooting/common-issues/unclean-shutdowns.mdx | 2 +- .../using-unraid-to/manage-storage/array-configuration.mdx | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx b/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx index 8892393443..c5a891e19a 100644 --- a/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/system-crashes-and-stability.mdx @@ -33,10 +33,11 @@ To test your RAM: 1. Restart your server and select **Memtest86+** from the boot menu. 2. Let the test run for at least 2-4 hours for thorough coverage. 3. Monitor for any error messages or failed tests. -4. For the latest version with enhanced DDR4/DDR5 compatibility, download from [memtest.org](https://www.memtest86.com/). :::note[Other RAM testing tools] +- [**MemTest86+**](https://www.memtest.org/): Open source tool included with Unraid +- [**MemTest86**](https://www.memtest86.com/): Commercial tool with support for modern hardware - [**Karhu RAM Test**](https://www.karhusoftware.com/): A paid but highly effective Windows-based tool that can detect errors faster than traditional methods, with detection rates of 95.67% within 30 minutes (ideal for DDR5 systems) - [**HCI MemTest**](https://hcidesign.com/memtest/): Popular, free Windows-based tester - [**Prime95**](https://prime95.net/): Validates RAM and CPU stability simultaneously diff --git a/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx b/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx index fd228cbc25..511a7b6704 100644 --- a/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx +++ b/docs/unraid-os/troubleshooting/common-issues/unclean-shutdowns.mdx @@ -30,7 +30,7 @@ A well-configured UPS is your best defense against unclean shutdowns caused by p - **Configure shutdown timeouts:** Set the UPS to trigger a controlled shutdown before the battery runs low. Adjust the "Battery runtime left" or "Battery charge level" thresholds to provide enough time for Unraid to [stop the %%array|array%%](../../using-unraid-to/manage-storage/array-configuration.mdx#startstop-the-array) and power down safely. - **Test your configuration:** Simulate a power loss to ensure the UPS and Unraid respond correctly. -Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4?srsltid=AfmBOop675PrJQW4iqb4JBN3GyPpwDDiSmnZReq78t27XyxkFdMX8inO#:~:text=NUT%20%2D%20Network%20UPS%20Tools) for broader compatibility for more advanced UPS models or unsupported hardware. +Look into the [NUT plugin](https://unraid.net/community/apps/c/plugins/p4?srsltid=AfmBOop675PrJQW4iqb4JBN3GyPpwDDiSmnZReq78t27XyxkFdMX8inO#:~:text=NUT%20%2D%20Network%20UPS%20Tools) for broader compatibility with more advanced UPS models or unsupported hardware. ::: diff --git a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx index 4eef0c4dba..8bc50b0b3a 100644 --- a/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx +++ b/docs/unraid-os/using-unraid-to/manage-storage/array-configuration.mdx @@ -407,7 +407,7 @@ When upgrading your data drive to a larger one, here are some points to keep in - **Backup the old disk:** Keep the original disk intact until the upgrade is confirmed successful. This provides a fallback option if anything goes wrong. -:::caution[Warning] +:::warning Replacing drives always involves some risk. If another drive fails during the upgrade, especially with only single parity, you may experience data loss. Always check the health of your drives before beginning the process, and ensure that you keep the old drive intact until the upgrade is complete and your data is confirmed to be safe. @@ -1313,7 +1313,7 @@ If your array won't start, follow these steps to identify and fix common problem - **Trial License:** Full Unraid access for 30 days, just like the higher license tiers. You can use unlimited storage devices, but you'll need an internet connection to start it up. [Start a new trial here.](https://unraid.net/getting-started) - - **Paid License:** This is yours to keep forever! However, there are limits on the number of devices based on the plan you choose (**Starter**, **Unleased**, or **Lifetime**). After you activate it, you don't have to connect to the internet anymore. + - **Paid License:** This is yours to keep forever! However, there are limits on the number of devices based on the plan you choose (**Starter**, **Unleashed**, or **Lifetime**). After you activate it, you don't have to connect to the internet anymore. :::