From 5a756b3f870e9739749a20b1650e83426c135984 Mon Sep 17 00:00:00 2001 From: GitHub Copilot Date: Mon, 6 Apr 2026 03:47:54 +0000 Subject: [PATCH] docs: document Artifactory Archive Entry Download optimization (#525) Virtual file packages installed via an Artifactory proxy now use the Archive Entry Download API to fetch individual files directly, avoiding full archive downloads. Document this behavior and fallback in the Authentication guide's Registry proxy section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../content/docs/getting-started/authentication.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/src/content/docs/getting-started/authentication.md b/docs/src/content/docs/getting-started/authentication.md index 6ba4b733c..8cd752a38 100644 --- a/docs/src/content/docs/getting-started/authentication.md +++ b/docs/src/content/docs/getting-started/authentication.md @@ -199,6 +199,18 @@ With `PROXY_REGISTRY_ONLY=1`, APM will: 2. Skip the download cache for entries that have no `registry_prefix` (forcing a fresh proxy download) 3. Raise an error for any package reference that does not route through the configured proxy +### Archive Entry Download + +When installing virtual file packages (`.prompt.md`, `.agent.md`, `.instructions.md`, etc.) through an Artifactory proxy, APM uses the [Archive Entry Download API](https://jfrog.com/help/r/jfrog-artifactory-documentation/archive-entry-download) to fetch individual files directly instead of downloading the full archive. + +The entry URL pattern appends `!/{root}/{file}` to the archive URL: + +``` +GET https://art.example.com/artifactory/github/{owner}/{repo}/archive/{ref}.zip!/{repo}-{ref}/{file} +``` + +If the entry API returns a 404, connection error, or is not supported by the Artifactory version in use, APM falls back to downloading the full archive transparently. No configuration is required -- the optimization is automatic. + ### Deprecated Artifactory env vars The following env vars still work but emit a `DeprecationWarning`. Migrate to the `PROXY_REGISTRY_*` equivalents: