Skip to content

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

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

docs: Add reverse proxy X-Forwarded-Port blurb#33
stonith wants to merge 2 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

  • Documentation
    • Clarified Nginx reverse proxy configuration guidance for setups using different public and internal listening ports.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

📝 Walkthrough

Walkthrough

Documentation update adds a clarifying note about configuring X-Forwarded-Port in Nginx reverse proxy setups for Kobo integration. The note specifies that this header should reflect the public listening port rather than the internal $server_port variable 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

🐰 A rabbit hops through ports so fine,
Public and private, all in line,
X-Forwarded clears the way,
Reverse proxies work today! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The pull request title follows the conventional commit format with 'docs:' prefix and clearly describes the main change of adding documentation about reverse proxy X-Forwarded-Port configuration.
Description check ✅ Passed The PR description is mostly complete with the required sections, though some checklist items remain unchecked and Manual Testing Steps section is missing.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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
@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
large_client_header_buffers 8 32k;
```

:::info[X-Forwarded-Port] It's common in reverse proxy setups to port forward public listening ports to a different internal port. If your public listening port is different from $server_port, you must set X-Forwarded-Port to the public listening port. ie. public exposed port is 443 while nginx is listening on 8443
Copy link
Copy Markdown
Contributor

@imnotjames imnotjames May 26, 2026

Choose a reason for hiding this comment

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

Suggested change
:::info[X-Forwarded-Port] It's common in reverse proxy setups to port forward public listening ports to a different internal port. If your public listening port is different from $server_port, you must set X-Forwarded-Port to the public listening port. ie. public exposed port is 443 while nginx is listening on 8443
:::info[X-Forwarded-Port]
If your public listening port is different from your internal $server_port, you should set X-Forwarded-Port to the public listening port.
For example, if your public server is available on port 443, but nginx is listening on 8443 you will need to set X-Forwarded-Port to port 443.

Thoughts on this rewording? I also added a newline. I don't know if that's needed but it's how the other alert boxes are.

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