-
Notifications
You must be signed in to change notification settings - Fork 49
Advanced Usage
Certain packages must be encoded when described as a Package URL. For more information see Character encoding in the Package URL specification.
If you're using an alternate endpoint, such as a corporate NPM mirror, you can set certain environment variables to redirect traffic to that location instead of the default one. These environment variables include:
-
GITHUB_ACCESS_TOKEN: When connecting to GitHub, this environment variable must be defined (only used for OSS Health). -
CARGO_ENDPOINT: Connect to Cargo (Rust), default value is https://crates.io. -
CARGO_ENDPOINT_STATIC: Connect to Cargo (Rust), default value is https://static.crates.io. -
COCOAPODS_SPECS_ENDPOINT: Connect to Cocoapods (MacOS / iOS), default value is https://github.com/Cocoapods/Specs/tree/master. -
COCOAPODS_SPECS_RAW_ENDPOINT: Connect to Cocoapods (MacOS / iOS), default value is https://raw.githubusercontent.com/CocoaPods/Specs/master. -
COCOAPODS_METADATA_ENDPOINT: Connect to Cocoapods (MacOS / iOS), default value is https://cocoapods.org. -
COMPOSER_ENDPOINT: Connect to Composer (PHP), default value is https://repo.packagist.org. -
CPAN_ENDPOINT: Connect to CPAN (Perl), default value is https://metacpan.org. -
CPAN_BINARY_ENDPOINT: Connect to CPAN (Perl), default value is https://cpan.metacpan.org. -
CRAN_ENDPOINT: Connect to CRAN (R), default value is https://cran.r-project.org. -
GO_PROXY_ENDPOINT: Connect to a Go Proxy, default value is https://proxy.golang.org. -
GO_PKG_ENDPOINT: Connect to the Go Package Repository, default value is https://pkg.go.dev. -
HACKAGE_ENDPOINT: Connect to Hackage (Haskell), default value is https://hackage.haskell.org. -
MAVEN_ENDPOINT: Connect to Maven (Java), default value is https://repo1.maven.org/maven2. -
NPM_ENDPOINT: Connect to NPM (JavaScript), default value is https://registry.npmjs.org. -
NUGET_ENDPOINT_API: Connect to NuGet (.NET), default value is https://api.nuget.org. -
PYPI_ENDPOINT: Connect to PyPI (Python), default value is https://pypi.org. -
RUBYGEMS_ENDPOINT: Connect to RubyGems (Ruby), default value is https://rubygems.org. -
RUBYGEMS_ENDPOINT_API: Connect to RubyGems (Ruby), default value is https://api.rubygems.org. -
UBUNTU_ARCHIVE_MIRROR: Ubuntu archive mirror, default value is https://mirror.math.princeton.edu/pub. -
UBUNTU_ENDPOINT: Ubuntu package repository, default value is https://packages.ubuntu.com. -
UBUTNU_POOL_NAMES: Ubuntu pools to query, default value is main,universe,multiverse,restricted. -
VS_MARKETPLACE_ENDPOINT: Connect to Visual Studio Marketplace, default value is https://marketplace.visualstudio.com.
Please note that for some systems, like Cocoapods, if you change one value, you'll very likely need to change the others.