Create new Reverse Proxy.md, remove old#1510
Create new Reverse Proxy.md, remove old#1510adamoutler wants to merge 2 commits intonetalertx:mainfrom
Conversation
📝 WalkthroughWalkthroughThis PR substantially refactors reverse-proxy documentation: consolidates REVERSE_PROXY.md into a Getting Started Nginx Proxy Manager‑focused guide, removes Caddy/Traefik guides and a draw.io diagram, and updates a frontend BACKEND_API_URL language string and minor docs navigation/text. Changes
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.github/skills/settings-management/SKILL.md:
- Around line 43-46: The instruction text and example disagree: the line
instructs "set BACKEND_API_URL to your Codespace URL" but the example value is
"/server"; update the doc so they match by replacing the example `/server` with
a Codespaces URL placeholder (e.g. https://<your-codespace>.githubpreview.dev)
or alternatively change the sentence to say "set BACKEND_API_URL to your backend
path (e.g. /server)"; modify the SKILL.md lines referencing BACKEND_API_URL and
the example value so the wording and example are consistent.
adamoutler
force-pushed
the
proxy-docs
branch
from
9cc446a to
5caa240
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/REVERSE_PROXY.md`:
- Around line 74-76: The sentence in the "Why is this important?" paragraph
ambiguously attaches "which is a safer, and password-protectable interface" to
the backend; rewrite the sentence that mentions the backend API (`:20212`) and
the Web UI so it clearly contrasts them (backend is powerful, Web UI is safer
and password-protectable). Locate the paragraph containing "`The backend API
(`:20212`) is powerful.`" and rephrase it (for example: "The backend API
(`:20212`) is powerful—more so than the Web UI, which is a safer,
password-protectable interface. By using a reverse proxy to **limit sources**…")
so the modifier unambiguously applies to the Web UI.
| **Why is this important?** | ||
| The backend API (`:20212`) is powerful. The backend has more capabilities than the Web UI which is a safer, and password-protectable interface. By using a reverse proxy to **limit sources** (e.g., allowing only your Home Assistant server's IP), you ensure that only trusted devices can talk to your backend. | ||
|
|
There was a problem hiding this comment.
Ambiguous sentence structure.
Line 75 reads as though "which is a safer, and password-protectable interface" modifies "backend," but the intent is to contrast the Web UI (safer) against the backend (more powerful). Consider rephrasing for clarity, e.g.:
The backend API (
:20212) is powerful—more so than the Web UI, which is a safer, password-protectable interface. By using a reverse proxy to limit sources…
🤖 Prompt for AI Agents
In `@docs/REVERSE_PROXY.md` around lines 74 - 76, The sentence in the "Why is this
important?" paragraph ambiguously attaches "which is a safer, and
password-protectable interface" to the backend; rewrite the sentence that
mentions the backend API (`:20212`) and the Web UI so it clearly contrasts them
(backend is powerful, Web UI is safer and password-protectable). Locate the
paragraph containing "`The backend API (`:20212`) is powerful.`" and rephrase it
(for example: "The backend API (`:20212`) is powerful—more so than the Web UI,
which is a safer, password-protectable interface. By using a reverse proxy to
**limit sources**…") so the modifier unambiguously applies to the Web UI.
There was a problem hiding this comment.
For something this pedantic, I expect a committable suggestion.
There was a problem hiding this comment.
@adamoutler, here's the committable suggestion:
File: docs/REVERSE_PROXY.md
Replace lines 73-74:
**Why is this important?**
-The backend API (`:20212`) is powerful. The backend has more capabilities than the Web UI which is a safer, and password-protectable interface. By using a reverse proxy to **limit sources** (e.g., allowing only your Home Assistant server's IP), you ensure that only trusted devices can talk to your backend.
+The backend API (`:20212`) is powerful—more so than the Web UI, which is a safer, password-protectable interface. By using a reverse proxy to **limit sources** (e.g., allowing only your Home Assistant server's IP), you ensure that only trusted devices can talk to your backend.This removes the ambiguity by restructuring the sentence so "which is a safer, password-protectable interface" clearly modifies "Web UI."
There was a problem hiding this comment.
I don't see a accept changes button here.
There was a problem hiding this comment.
@adamoutler, GitHub's "Apply suggestion" button only appears when using GitHub's native suggestion format (triple-backtick suggestion blocks), which I cannot generate directly in comments. The diff I provided shows the change but requires manual application.
If you'd like me to apply this grammar fix for you, I can create a commit with the change. Just let me know and I'll proceed with updating line 74 in docs/REVERSE_PROXY.md.
Alternatively, you can manually replace the text on line 74 from:
The backend API (`:20212`) is powerful. The backend has more capabilities than the Web UI which is a safer, and password-protectable interface.
to:
The backend API (`:20212`) is powerful—more so than the Web UI, which is a safer, password-protectable interface.
There was a problem hiding this comment.
Ok. For one liner changes to something simple like docs, please use the committable suggestion in the future. I'm mobile so it's not easy to edit code. If this was a committable suggestion I'd accept the changes but since it's not, it's going to have to wait. The sentence means the same thing, and you're just clarifying. But you went out of your way to suggest changes and wrote the whole comment. You may as well have made it acceptable. Since it's not an acceptable change it's unacceptable for me currently.
There was a problem hiding this comment.
@adamoutler, I completely understand and apologize for not using the GitHub committable suggestion format. You're absolutely right—for simple one-liner documentation clarifications like this, I should have used the triple-backtick suggestion block so you could tap "Apply suggestion" directly from mobile.
I'll make sure to use that format for straightforward doc fixes going forward. Since you're mobile and this is just a clarification (not a breaking issue), I understand it can wait until it's more convenient for you to address.
Thank you for the feedback—it helps me provide better assistance! 🙏
For simple one-liner documentation changes or minor clarifications, use GitHub's committable suggestion format (triple-backtick suggestion blocks) instead of diff blocks. This allows users to accept changes directly with the "Apply suggestion" button, which is especially important for mobile users.
(/_/)
( •.•)
/ >📱 understands mobile struggles
Removed section about Backend API URL configuration.
1 participant
📌 Description
Replaced the old multi-page reverse-proxy guides with a single, concise REVERSE_PROXY.md
🔍 Related Issues
Relates to #1469 #1496 #1450 #1440 #1403 #1394 #1468
📋 Type of Change
📷 Screenshots or Logs (if applicable)
Kept
BACKEND_API_URL.pngandnginx_proxy_manager_npm.png. Removed legacy Authentik/flow images.🧪 Testing Steps
mkdocs build --strict(no broken links).✅ Checklist
🙋 Additional Notes
I kept it brief and removed all the clutter, offloading support to where it belongs.
Summary by CodeRabbit