Skip to content

docs(connect): align remote access guide with current UI #468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elibosley merged 2 commits into from
Apr 23, 2026
+44 −56
Merged

docs(connect): align remote access guide with current UI #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d48559
docs(connect): align remote access guide with UI
elibosley Apr 22, 2026
9ce310b
docs(connect): prefer Tailscale for remote admin
elibosley Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/unraid-connect/overview-and-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ Unraid Connect works seamlessly with Unraid OS, boosting your server experience

With Unraid Connect, you can:

- Remotely access and manage your Unraid server from any device, anywhere in the world.
- Monitor your server and manage supported Connect features from any device, anywhere in the world.
- Monitor real-time server health and resource usage, including storage, network, and Docker container status.
- Perform and schedule secure online flash backups to protect your configuration and licensing information.
- Receive notifications about server health, storage status, and critical events.
- Use dynamic remote access and server deep linking to navigate to specific management pages or troubleshoot issues quickly.
- Manage supported server actions through the Connect dashboard without exposing the full %%WebGUI|web-gui%% to the internet.
- Use remote access links and server deep linking to navigate to specific management pages or troubleshoot issues quickly.
- Manage multiple servers from a single dashboard, making it perfect for users with more than one Unraid system.

Unraid Connect is more than just an add-on; it's an essential extension of the Unraid platform, designed to maximize the value, security, and convenience of your Unraid OS investment.
Expand Down Expand Up @@ -114,16 +115,19 @@ When you click **Details** on a server, you will see:

:::tip

To use all management features, provision a myunraid.net certificate under ***Settings → Management Access*** on your server.
For full remote administration, prefer the official [%%Tailscale|tailscale%% integration](../unraid-os/system-administration/secure-your-server/tailscale.mdx). It gives you private remote access to the %%WebGUI|web-gui%% and services without exposing them to the public internet.

:::

With a valid **myunraid.net** certificate, Unraid Connect enables secure, remote server management directly from the Connect web interface.
Signing in to Unraid Connect gives you secure dashboard access without exposing the %%WebGUI|web-gui%% directly to the internet. The server maintains a secure outbound connection that enables supported Connect features with restricted API access.

If you also enable **Unraid Connect Remote Access**, that separate feature exposes the full %%WebGUI|web-gui%% through WAN port forwarding or %%UPnP|upnp%%. Use it only when you specifically need public browser access to the %%WebGUI|web-gui%%.

Remote management features include:

- **Remote WebGUI access:** Access the %%WebGUI|web-gui%% from anywhere.
- **Array controls:** Start or stop %%array|array%%s and manage storage pools.
- **Dashboard-based management:** Use supported Connect controls without opening the full %%WebGUI|web-gui%% to the internet.
- **Optional Remote WebGUI access:** Access the full %%WebGUI|web-gui%% from anywhere if you separately enable Unraid Connect Remote Access.
- **Array controls:** Start or stop %%array|array%%s and manage storage pools through supported Connect actions.
- **Docker and VM management:** View, start, stop, and monitor containers and %%VM|vm%%s.
- **Parity & Scrub:** Launch %%parity check|parity-check%% or %%ZFS|zfs%%/%%BTRFS|btrfs%% scrub jobs
- **Flash backup:** Trigger and monitor flash device backups to the cloud.
Expand Down
82 changes: 33 additions & 49 deletions docs/unraid-connect/remote-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,31 @@ sidebar_position: 3
sidebar_label: Remote access
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import RemoteAccessDynamic from './partials/remote-access/dynamic.mdx';
import RemoteAccessStatic from './partials/remote-access/static.mdx';

# Remote access

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.
This page covers **Unraid Connect Remote Access**, which publishes your %%WebGUI|web-gui%% to the internet by using either %%UPnP|upnp%% or a manual port forwarding rule on your router. If you want full remote management without exposing the %%WebGUI|web-gui%% to WAN traffic, prefer the official [%%Tailscale|tailscale%% integration](../unraid-os/system-administration/secure-your-server/tailscale.mdx). 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]

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

:::

:::note[Connect dashboard access is different]

Signing in to the [Unraid Connect dashboard](https://connect.myunraid.net/) does **not** by itself expose your %%WebGUI|web-gui%% to the internet. Dashboard access uses a server-initiated connection with restricted API access for supported Connect features. **Unraid Connect Remote Access** is a separate feature that exposes the full %%WebGUI|web-gui%% through WAN port forwarding or %%UPnP|upnp%%.

:::

Remote access through Unraid Connect provides:

- **Convenience** - Quickly access your server’s management interface from anywhere, using a secure, cloud-managed connection.
- **Security** - Dynamic access modes limit exposure by only allowing access to the internet when necessary, which helps reduce risks from automated attacks.
- **Simplicity** - No need for manual port forwarding or VPN client setup for basic management tasks.
- **Convenience** - Quickly access your server’s management interface from anywhere, using a trusted Unraid Connect URL.
- **Security** - Your %%WebGUI|web-gui%% traffic is encrypted when SSL/TLS is configured correctly.
- **Simplicity** - %%UPnP|upnp%% can create the required port mapping automatically when your router supports it.

:::tip
:::tip[Preferred approach]

For full network access or advanced use cases, consider setting up [Tailscale](../unraid-os/system-administration/secure-your-server/tailscale.mdx) or a VPN solution.
For most users, the official [%%Tailscale|tailscale%% integration](../unraid-os/system-administration/secure-your-server/tailscale.mdx) is the better choice for remote administration because it avoids exposing the %%WebGUI|web-gui%% to the public internet. Use Unraid Connect Remote Access only when you specifically need browser access to the public-facing %%WebGUI|web-gui%% URL.

:::

Expand All @@ -45,45 +46,32 @@ Your Unraid server will be ready to accept secure remote connections via the %%W

---

## Choosing a remote access type

Unraid Connect offers two modes:
## Choosing a remote access configuration

<Tabs>
<TabItem value="dynamic" label="Dynamic remote access" default>
<RemoteAccessDynamic />
</TabItem>
In current Unraid 7.2.x releases, the Unraid API settings page exposes these remote access controls:

<TabItem value="static" label="Static remote access">
<RemoteAccessStatic />
</TabItem>
</Tabs>
- **Allow Remote Access** - Choose whether remote access is **Disabled** or **Always** available.
- **Remote Access Forward Type** - Choose **Static** for manual port forwarding, or **UPnP** to let your router create the port mapping automatically.
- **Remote Access WAN Port** - Choose the WAN port to forward when using **Static** forwarding.
Comment on lines +45 to +49
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Use the current UI labels in the control list.

The PR objective calls out Forward Type and WAN Port as the current labels, but this section introduces Remote Access Forward Type and Remote Access WAN Port. That reintroduces the same UI mismatch this doc update is meant to fix, and the same names are repeated later on Lines 61-64.

✏️ Proposed wording 
-- **Remote Access Forward Type** - Choose **Static** for manual port forwarding, or **UPnP** to let your router create the port mapping automatically.
-- **Remote Access WAN Port** - Choose the WAN port to forward when using **Static** forwarding.
+- **Forward Type** - Choose **Static** for manual port forwarding, or **UPnP** to let your router create the port mapping automatically.
+- **WAN Port** - Choose the WAN port to forward when using **Static** forwarding.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
In current Unraid 7.2.x releases, the Unraid API settings page exposes these remote access controls:
## Dynamic remote access setup
- **Allow Remote Access** - Choose whether remote access is **Disabled** or **Always** available.
- **Remote Access Forward Type** - Choose **Static** for manual port forwarding, or **UPnP** to let your router create the port mapping automatically.
- **Remote Access WAN Port** - Choose the WAN port to forward when using **Static** forwarding.
In current Unraid 7.2.x releases, the Unraid API settings page exposes these remote access controls:
- **Allow Remote Access** - Choose whether remote access is **Disabled** or **Always** available.
- **Forward Type** - Choose **Static** for manual port forwarding, or **UPnP** to let your router create the port mapping automatically.
- **WAN Port** - Choose the WAN port to forward when using **Static** forwarding.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/unraid-connect/remote-access.mdx` around lines 45 - 49, The listed
control labels use outdated/incorrect names ("Remote Access Forward Type" and
"Remote Access WAN Port") instead of the actual UI labels; update the doc so the
bullet list and subsequent mentions use the exact current UI labels "Forward
Type" and "WAN Port" (keeping "Allow Remote Access" as-is) to match the PR
objective and other occurrences (search for the phrases "Remote Access Forward
Type" and "Remote Access WAN Port" and replace them with "Forward Type" and "WAN
Port" in the same section).


| Feature | Dynamic remote access | Static remote access |
| ------------------------------------ | --------------------------- | ------------------------- |
| %%WebGUI\|web-gui%% open to internet | Only when enabled | Always |
| Attack surface | Minimized | Maximized |
| Automation | Auto open/close via Connect | Manual setup, always open |
| %%UPnP\|upnp%% support | Yes | Yes |
| | **Recommended for most** | |
When remote access is set to **Always**, your %%WebGUI|web-gui%% is continuously reachable from the internet on the configured WAN port. Both **Static** and **UPnP** remote access publish the %%WebGUI|web-gui%% to WAN traffic. Use a strong root password, keep Unraid OS updated, and disable remote access when you do not need it.

## Dynamic remote access setup
Dynamic, on-demand remote access is not currently exposed in the Unraid API settings page. If you need remote management without keeping the %%WebGUI|web-gui%% exposed through port forwarding, prefer [%%Tailscale|tailscale%%](../unraid-os/system-administration/secure-your-server/tailscale.mdx) or another %%VPN Tunnel|vpn-tunnel%%.

To set up dynamic remote access:
## Enable remote access

1. In ***Settings → Management Access → Unraid API***, select a dynamic option from the Remote Access dropdown:
- **Dynamic - UPnP:** Uses %%UPnP|upnp%% to open and close a random port automatically (requires %%UPnP|upnp%% enabled on your router).
- **Dynamic - Manual port forward:** Requires you to forward the selected port on your router manually.

2. Navigate to [Unraid Connect](https://connect.myunraid.net/), and go to the management or server details page.

3. The **Dynamic remote access** card will show a button if your server isn’t currently accessible from your location.

4. Click the button to enable WAN access. If using %%UPnP|upnp%%, a new port forward lease is created (typically for 30 minutes) and auto-renewed while active.
To enable remote access:

5. The card will display the current status and %%UPnP|upnp%% state.
1. In the Unraid %%WebGUI|web-gui%%, navigate to ***Settings → Management Access*** and open the **Unraid API Settings** tab.
2. Set **Allow Remote Access** to **Always**.
3. Choose a **Remote Access Forward Type**:
- **UPnP:** Lets Unraid ask your router to create the WAN port mapping automatically. This requires %%UPnP|upnp%% support and %%UPnP|upnp%% enabled on your router.
- **Static:** Requires you to create the port forwarding rule manually on your router.
4. If you choose **Static**, enter the **Remote Access WAN Port** you want to use.
5. Click **Apply**.
6. Log in to [Unraid Connect](https://connect.myunraid.net/) and click the **Manage** link to connect to your server remotely.

6. After 10 minutes of inactivity - or if you click **Disable remote access** - internet access is automatically revoked. %%UPnP|upnp%% leases are removed as well.
If the **Manage** link does not work, use the relevant forwarding section below to verify that the WAN port reaches your server's HTTPS port.

---

Expand All @@ -100,13 +88,11 @@ To configure %%UPnP|upnp%%:
Navigate to ***Settings → Management Access*** and change **Use %%UPnP|upnp%%** to **Yes**.

3. **Select %%UPnP|upnp%% in Unraid Connect.**
On the Unraid Connect settings page, choose the remote access option as %%UPnP|upnp%% (select either Dynamic or Always On) and then click **Apply**.
On the Unraid API settings page, set **Allow Remote Access** to **Always**, set **Remote Access Forward Type** to **UPnP**, and then click **Apply**.

4. **Verify port forwarding (Always On only).**
4. **Verify port forwarding.**
Click the **Check** button. If successful, you'll see the message, "Your Unraid Server is reachable from the Internet."

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

:::caution[Troubleshooting]

If the setting changes from %%UPnP|upnp%% to Manual Port Forward upon reloading, Unraid might not be able to communicate with your router. Double-check that %%UPnP|upnp%% is enabled and consider updating your router's firmware.
Expand All @@ -129,9 +115,7 @@ To configure manual port forwarding:

Some routers may require the WAN port and HTTPS port to match. If so, use the same high random number for both.

4. **Verify port forwarding (Always On only):** Press the **Check** button. If everything is correct, you’ll see “Your Unraid Server is reachable from the Internet.”

For dynamic forwarding, ensure to click **Enable Dynamic Remote Access** in [Unraid Connect](https://connect.myunraid.net/) to enable access.
4. **Verify port forwarding:** Press the **Check** button. If everything is correct, you’ll see “Your Unraid Server is reachable from the Internet.”

5. **Access your server:** Log in to [Unraid Connect](https://connect.myunraid.net/) and click the **Manage** link to connect to your server remotely.

Expand Down
2 changes: 1 addition & 1 deletion docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Never expose the %%WebGUI|web-gui%% directly to the internet. Instead, use secur
- **%%WireGuard|wireguard%% VPN** is built into Unraid and provides a secure, encrypted tunnel for remote management.
- **%%OpenVPN|openvpn%%** is available as a plugin or Docker container.
- Many modern routers offer built-in VPN support - check your router documentation for setup.
- The [Unraid Connect](../../../unraid-connect/overview-and-setup.mdx) plugin enables remote access to the %%WebGUI|web-gui%%, but requires a port to be forwarded on your router.
- Signing in to [Unraid Connect](../../../unraid-connect/overview-and-setup.mdx) allows supported dashboard management without directly exposing the %%WebGUI|web-gui%% to the internet, but the separate Unraid Connect Remote Access feature does require WAN port forwarding or %%UPnP|upnp%%. Prefer %%Tailscale|tailscale%% when you need full remote %%WebGUI|web-gui%% access.

---

Expand Down