docs(connect): align remote access guide with current UI#468
Merged
Conversation
- Purpose: correct the Unraid Connect remote access guide so it matches the current Unraid 7.2.x settings UI. - Before: the guide described dynamic remote access choices and dashboard activation steps that are not exposed by the current settings form. - Problem: users on Unraid 7.2.4 only see Disabled/Always plus Static/UPnP forwarding, so the guide sent them looking for options that do not exist. - Change: document the current Allow Remote Access, Forward Type, and WAN Port controls, and clarify that on-demand dynamic remote access is not currently exposed. - How: replace the dynamic/static tabbed setup with current 7.2.x setup guidance and remove the overview claim about dynamic remote access.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughRewrites documentation for Unraid Connect remote access: rewords feature list to distinguish dashboard-managed Connect features from optional full WebGUI exposure, recommends Tailscale for private WebGUI access, and introduces conditional guidance for “Unraid Connect Remote Access” which uses WAN port forwarding/UPnP. Remote access docs move from a Dynamic/Static UI model to a Unraid 7.2.x API settings workflow (configure Allow Remote Access = Always, choose UPnP or Static, optional WAN port, verify via Connect Manage). Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
unraid-docs | 9ce310b | Commit Preview URL Branch Preview URL |
Apr 23 2026, 07:16 PM |
- Purpose: clarify that the preferred path for remote administration is the official Tailscale integration rather than Unraid Connect Remote Access. - Before: the docs distinguished the current UI from older dynamic settings, but they still did not clearly separate Connect dashboard access from the optional WebGUI exposure path. - Problem: readers could still infer that Connect sign-in and Connect Remote Access had the same exposure model, even though Remote Access publishes the WebGUI to WAN traffic while dashboard features use restricted server-initiated access. - Change: explicitly recommend Tailscale for full remote administration, explain that Connect dashboard access does not by itself expose the WebGUI, and warn that both Static and UPnP Connect Remote Access expose the WebGUI to the internet. - How: update the Connect overview, remote-access guide, and security fundamentals wording to distinguish dashboard management from optional public WebGUI access.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/unraid-connect/remote-access.mdx (1)
81-85:⚠️ Potential issue | 🟠 MajorDrop the stale
Use UPnPstep from this section.This page now says remote access is configured from Unraid API Settings via Allow Remote Access and Forward Type, but the UPnP instructions still tell readers to toggle Use UPnP first. That leaves two conflicting setup paths in the same guide.
✏️ Proposed wording
-2. **Enable %%UPnP|upnp%% in Unraid.** - Navigate to ***Settings → Management Access*** and change **Use %%UPnP|upnp%%** to **Yes**. - -3. **Select %%UPnP|upnp%% in Unraid Connect.** - On the Unraid API settings page, set **Allow Remote Access** to **Always**, set **Remote Access Forward Type** to **UPnP**, and then click **Apply**. +2. **Select %%UPnP|upnp%% in Unraid API Settings.** + Navigate to ***Settings → Management Access → Unraid API Settings***, set **Allow Remote Access** to **Always**, set **Forward Type** to **UPnP**, and then click **Apply**.🤖 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 81 - 85, Remove the stale "Enable %%UPnP|upnp%% in Unraid." step and any instruction that tells readers to toggle "Use %%UPnP|upnp%%" before proceeding; the guide should only instruct configuring remote access via the Unraid API settings (use "Allow Remote Access" and "Remote Access Forward Type"/"UPnP" on the Unraid API settings page and then click "Apply"). Update the section text so it no longer references the old Settings → Management Access step and ensure the remaining steps consistently reference "Allow Remote Access" and "Remote Access Forward Type" as the single configuration path.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/unraid-connect/remote-access.mdx`:
- Around line 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).
---
Outside diff comments:
In `@docs/unraid-connect/remote-access.mdx`:
- Around line 81-85: Remove the stale "Enable %%UPnP|upnp%% in Unraid." step and
any instruction that tells readers to toggle "Use %%UPnP|upnp%%" before
proceeding; the guide should only instruct configuring remote access via the
Unraid API settings (use "Allow Remote Access" and "Remote Access Forward
Type"/"UPnP" on the Unraid API settings page and then click "Apply"). Update the
section text so it no longer references the old Settings → Management Access
step and ensure the remaining steps consistently reference "Allow Remote Access"
and "Remote Access Forward Type" as the single configuration path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 06deec7d-e118-48d8-8f06-336f2edab938
📒 Files selected for processing (2)
docs/unraid-connect/overview-and-setup.mdxdocs/unraid-connect/remote-access.mdx
Comment on lines
+45
to
+49
| 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. |
Contributor
There was a problem hiding this comment.
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
A forum report showed that Unraid 7.2.4 users see
Allow Remote Access: Disabled/AlwayswithForward Type: Static/UPnP, while the docs were still instructing them to choose dynamic modes that do not exist in the current UI.The wording also needed a clearer security distinction: signing in to the Connect dashboard does not by itself expose the WebGUI to the internet, while Unraid Connect Remote Access does. For most users who want full remote administration, the official Tailscale integration is the better recommendation.
Validation
git diff --check origin/main...HEADContext
Forum thread: https://forums.unraid.net/topic/198357-unraid-connect-remote-access-settings-dont-match-guide-724/
Summary by CodeRabbit