chore: hostHeaders default value is empty string

[fengmk2]

pick from #5412

Summary by CodeRabbit

• Documentation
  • Updated plugin links to reflect the current repository addresses.
  • Improved clarity on host header behavior and configuration, including guidance for reverse proxy setups.
  • Enhanced textual explanations for properties related to host and protocol.

[coderabbitai]

Walkthrough

This pull request updates the documentation by revising URL links to the correct repositories for the Multipart and Session plugins and refining the text descriptions. In both the English and Chinese versions of the controller documentation, the default value for config.hostHeaders has been changed from x-forwarded-host to an empty string, and additional notes have been added regarding configuration behind a reverse proxy.

Changes

File	Change Summary
site/docs/…/controller.md	- Updated URLs for Multipart (egg-multipart) and Session (egg-session) plugins. - Revised descriptions for ctx.host and ctx.protocol. - Changed default for config.hostHeaders from x-forwarded-host to '' with a note on reverse proxies.
site/docs/…/controller.zh-CN.md	- Modified the description of the ctx.host getter. - Changed the default config.hostHeaders to ''. - Added an explanatory note for configuring reverse proxies when config.proxy is true.

Sequence Diagram(s):

(No sequence diagrams are provided as the changes are documentation updates without modifications to control flow.)

Poem

I'm just a hopping rabbit in the code field so wide,
Enhancing docs with updates on every side.
URLs now point where they truly belong,
And proxy notes help users stay strong.
With careful tweaks, our docs now sing—
A merry hop to newfound clarity and zing! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44cd620 and 8fc2553.

📒 Files selected for processing (2)

• site/docs/basics/controller.md (4 hunks)
• site/docs/basics/controller.zh-CN.md (1 hunks)

🔇 Additional comments (2)

site/docs/basics/controller.zh-CN.md (1)

601-603: Update config.hostHeaders Default Value in Chinese Documentation.
The documentation now clearly states that the default setting for config.hostHeaders is an empty string ('') and it provides guidance that if the application is deployed behind a reverse proxy (with config.proxy = true), a correct header value (e.g. x-forwarded-host) must be set. This clarification improves configuration security and precision.

site/docs/basics/controller.md (1)

608-612: Revised Default for config.hostHeaders in English Documentation.
The change updates the default value for config.hostHeaders to an empty string ('') and clearly explains that when behind a reverse proxy (with config.proxy = true), users must override this value with one that reflects their proxy’s actual header (such as x-forwarded-host). This revision enhances clarity and ensures correct configuration practices.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.