docs: document intended use and deployment, refresh SECURITY.md reporting policy#287
Open
ndoschek wants to merge 2 commits into
Open
docs: document intended use and deployment, refresh SECURITY.md reporting policy#287ndoschek wants to merge 2 commits into
ndoschek wants to merge 2 commits into
Conversation
- Add docs/deployment.md describing the Model Server's intended use as a local, trusted-environment development component and its trust model - Document the development-oriented defaults (all-interfaces bind, permissive CORS, no authentication) and a hardening checklist for responsible deployment - Add prominent README callouts (top matter and standalone-JAR quickstart) linking to the new document
- Adopt the updated Eclipse Foundation SECURITY.md template - Direct vulnerability reports to the Eclipse GitLab vulnerability tracker; email intake to security@eclipse.org is no longer accepted - Update the reporting policy link to eclipse.org/security/policy/
planger
approved these changes
Jul 22, 2026
planger
left a comment
planger
left a comment
Contributor
There was a problem hiding this comment.
Thanks, looks good to me! 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation clarifying that the Model Server is a development-time component intended to run locally in a trusted environment, and provides guidance for deploying it responsibly (network isolation, reverse proxy with authN/authZ + TLS, least privilege, trusted inputs). This makes the project's long-standing trust model and its development-oriented defaults (all-interfaces bind, permissive CORS, no authentication) explicit, following common practice for local-first tools (cf. Redis' "trusted environment" model) and OWASP guidance on documenting the intended runtime.
It also refreshes
SECURITY.mdto the current Eclipse Foundation template, since the previous email-based reporting channel was discontinued.What's included
Two separate commits:
docs/deployment.md("Intended Use, Deployment & Security Considerations"): what the Model Server is / isn't, its trust model, its default configuration, and a hardening checklist.README.md: prominent callouts (top matter + standalone-JAR quickstart) linking to the new doc.SECURITY.mdreporting-policy refreshSECURITY.mdtemplate.security@eclipse.orgis no longer accepted; Eclipse Foundation Security Team, 2026-06-30), and updates the policy link toeclipse.org/security/policy/.Documentation-only change; no code or behavior is modified.