Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .remarkrc.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import remarkFrontmatter from 'remark-frontmatter'
import remarkGfm from 'remark-gfm'
import remarkMdx from 'remark-mdx'
import remarkDirective from 'remark-directive'
import remarkPresetLintRecommended from 'remark-preset-lint-recommended'
import remarkLintListItemIndent from 'remark-lint-list-item-indent'
import remarkLintOrderedListMarkerStyle from 'remark-lint-ordered-list-marker-style'
Expand All @@ -23,6 +24,8 @@ import jsxContentSpacing from './remark-jsx-spacing.js'
const plugins = [
// MDX support
remarkMdx,
remarkDirective,
directiveColonSafe,
remarkFrontmatter,
remarkGfm,

Expand Down Expand Up @@ -79,3 +82,58 @@ const remarkConfig = {
};

export default remarkConfig

function directiveColonSafe() {
const data = this.data()
const extensions = data.toMarkdownExtensions || (data.toMarkdownExtensions = [])

for (const extension of extensions) {
if (
extension &&
typeof extension === 'object' &&
'handlers' in extension &&
extension.handlers &&
'containerDirective' in extension.handlers &&
Array.isArray(extension.unsafe)
) {
extension.unsafe = extension.unsafe.filter(
(rule) => rule.character !== ':'
)

wrapContainerDirectiveHandler(extension)
}
}

data.toMarkdownExtensions = extensions
}

function wrapContainerDirectiveHandler(extension) {
const {containerDirective} = extension.handlers

if (typeof containerDirective !== 'function') {
return
}

extension.handlers.containerDirective = function wrappedContainerDirective(
node,
parent,
state,
info
) {
const previous = state.bulletLastUsed
state.bulletLastUsed = undefined

try {
const output = containerDirective(node, parent, state, info)
return collapseDirectivePadding(output)
} finally {
state.bulletLastUsed = previous
}
}
}

function collapseDirectivePadding(value) {
return value
.replace(/(^|\n)([ \t]*:::[^\n]*?)\n\n/g, '$1$2\n')
.replace(/\n\n([ \t]*:::)/g, '\n$1')
}
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,7 @@ Unraid can import %%ZFS|zfs%% pools created on other platforms with minimal hass
5. **Finish and start array:** Click **Done**, then start the %%array|array%%.

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

:::

After importing, running a %%scrub|scrub%% is highly recommended to verify data integrity.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,11 @@ Unraid OS uses drives for various purposes:
To safeguard cached data, assign more than one device to the %%cache pool|cache-pool%%. A single device does not offer protection from data loss. %%Cache pools|cache-pool%% can be expanded on demand.

:::warning

SSD support is experimental in the %%array|array%%. Some SSDs may not perform well due to variations in %%TRIM/Discard|trim-discard%% implementation, which could lead to undesirable results. This does not apply to %%cache pools|cache-pool%%. [Learn more about filesystem options here](../../using-unraid-to/manage-storage/file-systems.mdx).

:::

:::note

SSD-based pools are optimal for applications and virtual machines, leveraging SSD performance for faster interactions. [Learn more about running applications here](../../using-unraid-to/run-docker-containers/overview.mdx).

:::

</details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,9 @@ Before deploying Unraid OS, it's important to verify your system's BIOS and stor
For further assistance, visit the [Unraid general support forum](https://forums.unraid.net/).

:::important

Many motherboards limit boot device selection to 12 hard drives. If your USB flash drive is recognized as a hard drive, you may not be able to boot from it after installing 12 physical hard drives. Configure the BIOS to treat the flash drive as a removable device whenever possible.

If using an add-on HBA, you may be able to disable INT 13h support to prevent its connected drives from appearing in the bootable devices list, helping to stay within the 12-drive limit.

:::

</details>
6 changes: 0 additions & 6 deletions docs/unraid-os/getting-started/what-is-unraid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,7 @@ Unraid features a [user-friendly web interface](./explore-the-user-interface/tou
Docker containers allow you to run applications in isolated, lightweight environments without the overhead associated with %%virtual machines|vm%%. Unraid simplifies the use of Docker by providing access to thousands of pre-configured apps through [Docker Hub](https://hub.docker.com/) and [Community Applications](../using-unraid-to/run-docker-containers/community-applications.mdx). This containerized approach enables Unraid users to run multiple applications simultaneously without compatibility issues. It also helps keep the system organized by using self-contained application packages and makes it easy to enhance server capabilities through Docker's ecosystem.

:::note

For advanced Docker settings, check out [Run Docker Containers](../using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx).

:::

</details>
Expand All @@ -125,9 +123,7 @@ Unraid features a [user-friendly web interface](./explore-the-user-interface/tou
Unraid functions as a virtualization host, using a %%hypervisor|hypervisor%% to securely allocate resources to virtualized guests. This allows you to run various applications in isolated environments, going beyond just network-attached storage.

:::tip

To use hardware virtualization in Unraid, ensure your CPU, chipset, BIOS, and device drivers are compatible. A full list of requirements is available in the [VM setup guide](../using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx). If your server doesn't meet these requirements, the %%VMs|vm%% menu will be disabled in the Unraid %%WebGUI|web-gui%%.

:::

<details>
Expand Down Expand Up @@ -188,9 +184,7 @@ Unraid features a [user-friendly web interface](./explore-the-user-interface/tou
For %%VM|vm%% setup steps, check out [Create virtual machines](../using-unraid-to/create-virtual-machines/overview-and-system-prep.mdx).

:::caution

%%GPU passthrough|gpu-passthrough%% requires compatible hardware (see [VM setup](../using-unraid-to/create-virtual-machines/vm-setup.mdx)).

:::

</details>
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,7 @@ This command provides a real-time process and resource monitor.
- Use arrow keys to scroll, and `k` to terminate processes.

:::tip

Consider using `htop` for a more user-friendly interface with enhanced controls.

:::

</details>
Expand All @@ -190,9 +188,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]

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

:::

</details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,15 @@ The plugin manages most sleep configuration options.
```

:::caution[Persistence]

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

1. Create a `go` file on your flash drive at `/boot/config/go`.

2. Add this line:

```
/sbin/ethtool -s eth0 wol g
```

:::

</details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ For more guidance on selecting the best flash device for Unraid, check out [Spac
- Avoid second-hand or previously used drives.
- Test the new drive on your server before transferring your license.
- Be cautious of counterfeit products, even from well-known brands.

:::note

The [forum announcement on counterfeit SanDisk drives](https://forums.unraid.net/topic/119052-psa-on-sandisk-usbs/) from January 2022 confirms SanDisk is not recommended due to counterfeit devices and manufacturing changes resulting in non-unique GUIDs. This affects both counterfeit and legitimate SanDisk drives.

:::
:::

:::

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y
5. Click **Apply**.

:::warning

Anyone on your network can intercept data sent over HTTP. Use HTTPS whenever possible.

:::

</details>
Expand All @@ -86,9 +84,7 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y
5. Click **Apply**.

:::important

Browsers will show a certificate error. All traffic is still encrypted after you accept the warning.

:::

</details>
Expand Down Expand Up @@ -124,15 +120,11 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y
- If you install the [Unraid Connect plugin](../../../unraid-connect/overview-and-setup.mdx), it will also be shown on the Connect dashboard.

:::info

The myunraid.net certificate is trusted by browsers and does not display warnings. The URL uses your LAN IP address with dots changed to dashes, plus a unique 40-character %%hash|hash%% assigned to your server.

:::

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

:::

</details>
Expand All @@ -155,7 +147,6 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y
If you install the [Unraid Connect plugin](../../../unraid-connect/overview-and-setup.mdx), it will also be shown on the Connect dashboard.

:::caution

If %%DNS|dns-name-resolution%% resolution becomes unavailable (e.g., your Internet connection goes down), you will not be able to access the %%WebGUI|web-gui%% using the Myunraid.net URL.

To regain access:
Expand All @@ -164,7 +155,6 @@ Below are the main ways to access your Unraid %%WebGUI|web-gui%%, depending on y
- Run `use_ssl no` to switch to HTTP (`http://[servername].[localTLD]` or `http://[ipaddress]`).
- Run `use_ssl yes` to switch to HTTPS using a self-signed certificate (`https://[servername].[localTLD]` or `https://[ipaddress]`). See [HTTPS with a self-signed certificate](#https-with-self-signed-certificate) above for more details.
- Once %%DNS|dns-name-resolution%% is restored, set **Use SSL/TLS** back to *Strict* for full security.

:::

</details>
Expand All @@ -177,10 +167,8 @@ When you access `http://[servername].[localTLD]`, the redirect behavior depends

- **Strict**: You will be redirected to `https://[lan-ip].[hash].myunraid.net`.
:::note

This can make local access difficult if %%DNS|dns-name-resolution%% is unavailable. See the caution under [HTTPS with Myunraid.net certificate and with no fallback URL](#https-with-myunraidnet-certificate-and-with-no-fallback-url).

:::
:::

- **Yes**: You will be redirected to `https://[servername].[localTLD]`. This will still work even if your internet connection is down.

Expand Down Expand Up @@ -227,9 +215,7 @@ If your certificate is invalid or does not match the server's URL, Unraid will d
7. Optionally, enable [Unraid Connect remote access](../../../unraid-connect/remote-access.mdx) for secure, browser-trusted remote management.

:::tip

For wildcard certificates, ensure the certificate's Subject Alternative Name or Subject field contains `*.[localTLD]` where `[localTLD]` is the exact value you entered in the **Local TLD** field in **Management Access**.

:::

</details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,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]

Never format an unmountable disk through the %%WebGUI|web-gui%%! Formatting erases all data and updates %%parity|parity%%, making recovery impossible.

:::
Expand Down Expand Up @@ -210,6 +211,7 @@ Here’s how to proceed:
```

:::danger

The `--repair` option is extremely dangerous and can cause further data loss. Always backup or image the disk first. Review [the documentation](https://btrfs.readthedocs.io/en/latest/btrfs-check.html) and consider seeking additional advice if you’re unsure.

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,10 +220,8 @@ System stability typically depends on:
Keeping your system firmware current helps prevent unexpected crashes and unlocks new hardware features.

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

:::

</details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,7 @@ If %%CRC errors|crc-errors%% continue after addressing cabling and power, furthe
- Maintains monitoring of the underlying problem

:::important

Acknowledging a warning doesn't fix the underlying issue - it just tells Unraid you're aware of it. You should still investigate and resolve the root cause of the %%CRC errors|crc-errors%%.

:::

</details>
15 changes: 3 additions & 12 deletions docs/unraid-os/troubleshooting/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,7 @@ If you need help with Unraid OS, you have several support options:
Refer to [Reset your password](../system-administration/secure-your-server/user-management.mdx#reset-your-password).

:::note

If you’re using encrypted drives and forget the encryption password, data recovery isn't possible - there is no backdoor.

:::

</details>
Expand All @@ -161,11 +159,12 @@ If you need help with Unraid OS, you have several support options:
7. Wipe existing filesystems from each data drive:

:::danger[Critical: Destructive Operation]

**This step will permanently erase ALL data on the specified drive(s) and is IRREVERSIBLE!**

- **Verify you have backups** of any data you need before proceeding

- **Double-check the device identifier** in the WebGUI or with `lsblk` before running this command

- **Ensure you're targeting the correct drive** - data loss from the wrong drive cannot be recovered

For each data drive, run:
Expand All @@ -175,7 +174,6 @@ If you need help with Unraid OS, you have several support options:
```

Replace `X` with the correct drive letter (e.g., sda, sdb, sdc)

:::

8. Continue with the normal Unraid setup and configuration.
Expand Down Expand Up @@ -293,10 +291,9 @@ If you need help with Unraid OS, you have several support options:
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**]

Before starting the conversion process, put your %%array|array%% into **Maintenance Mode**. This step ensures no writes occur during the conversion, protecting your data.

:::

<h3>Conversion process</h3>

1. Ensure you have a valid %%parity|parity%% and a current backup of your flash drive.
Expand All @@ -311,13 +308,11 @@ 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]

- **Partitioning is automatic**: Unraid automatically chooses the partitioning style based on drive size:
- **2TB or smaller**: Always uses MBR partitioning
- **Larger than 2TB**: Always uses GPT partitioning
- Starting with Unraid OS 6.9, partition 1 starts at 32KiB for rotational devices and 1MiB for non-rotational devices, regardless of the partition style.
- Always [back up your flash drive](../system-administration/secure-your-server/secure-your-flash-drive.mdx#backups) before starting this conversion process.

:::

</details>
Expand All @@ -336,9 +331,7 @@ If you need help with Unraid OS, you have several support options:
Yes. The **br0** bridge is a Linux network bridge allowing Docker containers and %%VM|vm%%s to connect directly to your local area network (LAN) with their IP addresses. It acts as a virtual network switch that connects your physical network interface to the virtual interfaces used by containers and %%VM|vm%%s.

:::note

Disabling br0 means that %%VMs|vm%% and Docker containers will not have direct access to the LAN and may lose some advanced networking features.

:::

</details>
Expand Down Expand Up @@ -439,9 +432,7 @@ If you need help with Unraid OS, you have several support options:
If you need more time with your [30-day free trial](https://unraid.net/download) of Unraid, you can extend it. Once your original trial expires, stop the %%array|array%% and go to the **Registration** page. You should see a button that allows you to request a 15-day extension. You can do this twice for a total of 60 days before you need to purchase a license.

:::important

You must use the same USB flash device to continue your trial. Changing the flash device will require starting a new trial from scratch.

:::

</details>
Expand Down
Loading