Skip to content

[docs] Update authentication docs for Artifactory Archive Entry Download #588

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.

Sign up for GitHub

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

Closed
danielmeppiel wants to merge 1 commit into from
Closed

[docs] Update authentication docs for Artifactory Archive Entry Download #588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/src/content/docs/getting-started/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading