Skip to content

docs: Add reverse proxy X-Forwarded-Port blurb#33

Open
stonith wants to merge 3 commits into
grimmory-tools:mainfrom
stonith:reverse-proxy-port-blurb
Open

docs: Add reverse proxy X-Forwarded-Port blurb#33
stonith wants to merge 3 commits into
grimmory-tools:mainfrom
stonith:reverse-proxy-port-blurb

Conversation

@stonith
Copy link
Copy Markdown

@stonith stonith commented May 24, 2026

Description

It's common for reverse proxy homelab setups to port forward a different public port to different internal port that the reverse proxy is listening on. Added a blurb to point out that X-Forwarded-Port may need a different setting.

Linked Issue

https://github.com/orgs/grimmory-tools/discussions/1476

Changes

Add info section to clarify X-Forwarded-Port reverse proxy header values

AI Disclosure

AI not used

Checklist

  • This PR links and implements an accepted issue.
  • This PR is a single focused change.
  • I ran the relevant validation for this change, such as npm run build and/or npm run typecheck.
  • I have added screenshots if there were any UI changes.
  • I have disclosed any AI usage as per the organization AI Policy above.
  • I understand all of my submitted changes.

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Clarified Nginx reverse proxy guidance: added an explanatory callout advising that the X-Forwarded-Port header should reflect the public listening port when it differs from the server's internal port (e.g., when port mappings expose a different external port). No behavioral changes to integration guidance beyond this clarification.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4bdd86a9-66e4-4f89-bdae-70b27251e208

📥 Commits

Reviewing files that changed from the base of the PR and between d046c82 and be3b15c.

📒 Files selected for processing (1)
  • docs/integration/kobo.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/integration/kobo.md

📝 Walkthrough

Walkthrough

Documentation update adds a clarifying note about configuring X-Forwarded-Port in Nginx reverse proxy setups for Kobo integration, specifying the header should reflect the public listening port rather than the internal $server_port when port mapping occurs.

Changes

Reverse proxy configuration clarification

Layer / File(s) Summary
X-Forwarded-Port guidance
docs/integration/kobo.md
Info callout added to clarify that X-Forwarded-Port should reflect the public exposed listening port (not $server_port) in reverse proxy scenarios with port mapping.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

enhancement

Poem

🐰 I hop between ports, quick and spry,
Public 443, nginx says hi,
Whispering headers on the run,
X-Forwarded-Port tells which one's done,
Docs updated — a tiny chore, hopped by for more.


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Description check ❌ Error The PR description includes most required sections but is missing Manual Testing Steps, which is marked as required in the template. Add a 'Manual Testing Steps' section with explicit steps used to verify the documentation changes and check for regressions.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title follows the conventional commit format with 'docs:' prefix and clearly describes the documentation addition.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot added the enhancement New feature or request label May 24, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/integration/kobo.md`:
- Around line 39-40: The admonition started with :::info[X-Forwarded-Port] is
left unclosed; update the block to follow the same open/body/close pattern used
elsewhere by placing the explanatory text as the body beneath the opener and
adding a closing ::: on its own line (i.e., keep the existing opener
':::info[X-Forwarded-Port]', move the explanatory sentence into the body, then
add ':::' to end the admonition).
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d4cd48b9-b7f0-493e-a5ac-78f4f07b5b6d

📥 Commits

Reviewing files that changed from the base of the PR and between fb075ec and d046c82.

📒 Files selected for processing (1)
  • docs/integration/kobo.md

Comment thread docs/integration/kobo.md Outdated
@stonith stonith changed the title Add reverse proxy X-Forwarded-Port blurb docs: Add reverse proxy X-Forwarded-Port blurb May 24, 2026
Comment thread docs/integration/kobo.md Outdated
Co-authored-by: James Ward <james@notjam.es>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants