📚 Fix TrustedProxies documentation related to IP ranges

[dreamscached]

Description

The behavior of iterating all IPs in a subnet has been changed in eee279b, but the documentation is still referring to older logic:

It can take IP or IP range addresses. If it gets IP range, it iterates all possible addresses.

Related to #1607, #1614, eee279b

Changes introduced

Removed the 'iterates all possible addresses' part from the documentation related to TrustedProxies as it is no longer the actual behavior of Fiber.

• Documentation Update: Detail the updates made to the documentation and links to the changed files.

Type of change

• Documentation update (changes to documentation)

Checklist

• Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
• Conducted a self-review of the code and provided comments for complex or critical parts.
• Updated the documentation in the /docs/ directory for Fiber's documentation.

Summary by CodeRabbit

• Documentation
  • Updated the fiber.Config documentation to refine the explanation of the TrustedProxies field, focusing on the list of trusted proxy IP addresses.

[welcome]

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

[coderabbitai]

Walkthrough

The recent update focuses on refining the documentation for the fiber.Config struct, specifically the TrustedProxies field. The change streamlines the content by eliminating details related to IP range iteration, opting instead to highlight the configuration of trusted proxy IP addresses. This adjustment aims to clarify the setup process for users, ensuring a more focused and straightforward understanding of trusted proxies in the Fiber framework.

Changes

File Path	Change Summary
docs/api/fiber.md	Modified TrustedProxies field documentation in fiber.Config, removing IP range iteration details.

🐇✨
In the land of code and wire,
A rabbit hopped, with a desire.
To clean the docs, make clear the mire,
"Trust your proxies," it did inspire.
With every hop, the docs got lighter,
A task complete, the future brighter. 🌟
🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 708e86b and 8241989.

Files selected for processing (1)

• docs/api/fiber.md (1 hunks)

[welcome]

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord