Document how to configure mirror mode (#1255) - #2126
Open
AzazelSensei wants to merge 2 commits into
Open
Conversation
Cover required properties, include/exclude extension lists, why local storage fails, and what actually works for an air-gapped install. Signed-off-by: Abdullah <89297042+AzazelSensei@users.noreply.github.com>
Contributor
|
ty, can you please sign the ECA? More details can be found here: https://api.eclipse.org/git/eca/status/gh/eclipse-openvsx/openvsx/2126 |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Changes are documentation-only and the added guidance aligns with the mirror-mode implementation; only a minor wording clarification was suggested.
Pull request overview
Adds user-facing documentation for running Open VSX Server in “mirror mode” (syncing metadata and extension files from an upstream registry), addressing the configuration questions raised in #1255.
Changes:
- Link mirror-mode documentation from the main README.
- Add a dedicated
doc/mirror.mdexplaining required properties, include/exclude lists, storage requirements, and air-gapped constraints. - Cross-link mirror-mode docs from
doc/development.md.
File summaries
| File | Description |
|---|---|
| README.md | Adds a pointer to the new mirror-mode documentation. |
| doc/mirror.md | New end-to-end mirror-mode configuration guide (properties, partial mirroring, storage, air-gapped notes). |
| doc/development.md | Adds a short mirror-mode section linking to the new guide. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
JobRunr uses 5-field cron, not Spring 6-field form with seconds. Signed-off-by: Abdullah <89297042+AzazelSensei@users.noreply.github.com>
Author
|
Thanks. I'll sign the ECA and match the commit email to the Eclipse account. |
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
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.
Fixes #1255
I wrote down how to turn on mirror mode: the required properties, include/exclude lists (
namespace.nameornamespace.*, no version filter), and that local filesystem storage does not work becausegetBaseUrlis empty outside a request. Air-gapped machines still need a networked mirror (orovsxCLI publishes) to get the files in.