Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: add gateways and proxies section to README #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmruiz merged 4 commits into mongodb-js:main from nickytonline:docs-gateway-update
Aug 19, 2025

Conversation

Copy link
Contributor

@nickytonline nickytonline commented Aug 10, 2025

Proposed changes

As per you comment in #416 @kmruiz, I've submitted a PR to get the ball rolling. This PR adds a gateways and proxies section to the README docs.

Closes #416

Checklist

kmruiz reacted with heart emoji
@Copilot Copilot AI review requested due to automatic review settings August 10, 2025 04:31
@nickytonline nickytonline requested a review from a team as a code owner August 10, 2025 04:31
Copilot

This comment was marked as outdated.

Copy link
Contributor Author

nickytonline commented Aug 10, 2025
edited
Loading

Also, just an FYI, I'm n on PTO this coming week so won't be able to address any feedback until the end of next week.

Copy link
Collaborator

kmruiz commented Aug 11, 2025
edited
Loading

Hi @nickytonline !

Thanks for opening the PR. I've been reviewing it and so far it looks good. I've added a few changes to clarify that having these examples in the README.md do not:

  • Endorse any third party.
  • They are not enough in terms of security best practices and should be reviewed.
  • We provide them in a best-effort basis and we don't do technical support on them (delegated to the actual third-party).

I'll ask other teammates to review this and if everything looks fine for them too, we'll merge it and close the underlying issue.

Thanks a lot for your contribution and enjoy your PTO!

nickytonline reacted with heart emoji

@kmruiz kmruiz requested a review from Copilot August 11, 2025 09:13
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the README documentation by replacing a basic proxy support section with a comprehensive "Gateways and Proxies" section that covers both inbound authentication security and outbound proxy configuration.

  • Reorganizes proxy documentation with better structure and security guidance
  • Adds detailed information about authentication gateways like Pomerium for securing remote MCP deployments
  • Expands proxy configuration examples with environment variables and usage instructions
Comments suppressed due to low confidence (1)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@kmruiz kmruiz merged commit df72a33 into mongodb-js:main Aug 19, 2025
17 checks passed
nirinchev added a commit that referenced this pull request Aug 19, 2025
Copy link
Collaborator

I've reverted this change due to the strict rules we have around linking to external vendors.

We welcome contributions that genuinely help users, but they should provide clear, actionable examples and practical implementation guidance and not implicitly or explicitly endorse or promote external vendors. You're welcome to resubmit this change, but I will ask you to omit the "Pomerium (Open Core Identity-Aware Proxy)" and "Add Your Gateway/Proxy Solution" sections, as those are not aligned with the goals of this project's readme.

nickytonline reacted with thumbs up emoji

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kmruiz kmruiz kmruiz approved these changes

Copilot code review Copilot Copilot left review comments

@himanshusinghs himanshusinghs himanshusinghs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Concrete Gateway Examples to Security Documentation

AltStyle によって変換されたページ (->オリジナル) /