Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Sources
The read, write, or readwrite
(defaults to read).
Use a backtick (`) to escape characters inside the source strings.
clear
Syntax: clear
Removes all previous sources in the configuration string. Useful in combination with the
--x-asset-sources parameter to disable all asset caching sources coming from the
X_VCPKG_ASSET_SOURCES environment variable.
Azure Blob Storage (x-azurl)
Syntax:
x-azurl,[, [, ]] x-azurl,file://[,, ]
/.
Non-Azure endpoints can provide an access token using this parameter. As long as they can respond to
GET and PUT requests of the form
For example, a source configured as follows: azurl,https://mydomain.com/vcpkg/,token=abc123,readwrite, produces a request in the form: https://mydomain.com/vcpkg/.
Alternatively, you can use a filesystem location as the endpoint by using the
x-azurl,file:// pattern.
For example, x-azurl,file://Z:/vcpkg/assetcache/,,readwrite configures a cache in the Z:/
network folder.
The workflow of this asset source is:
- Attempt to read from the mirror
- (If step 1 failed) Read from the original url
- (If step 2 succeeded) Write back to the mirror
You can enable/disable steps 1 and 3 via the x-block-origin below.
See also the binary caching documentation for Azure Blob
Storage for more information on how to
set up an x-azurl source.
x-block-origin
Syntax: x-block-origin
Disables falling back to the original download URL when an asset is not found in any of the configured sources.
x-script
Syntax: x-script,
Dispatches to an external tool to fetch the asset.
: Required. A command template that vcpkg executes to acquire an asset. For example:
x-script,curl -L {url} --output {dst} configures vcpkg to execute curl and provide the {url}
and {dst} parameters.
The logic to restore and upload assets and to connect to the cache storage endpoint are responsibility of the command provided within the template.
vcpkg will substitute these arguments when executing the command:
{url}: the original download URL for the asset.{sha512}: the expected SHA512 of the downloaded asset.{dst}: the location where the downloaded asset is expected.
The template command is run within vcpkg's build environment; this means that some environment
variables like PATH may be modified by the triplet.
Next step
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
