From 6b24f0fa76d171c5756f01f407682f7274cfe238 Mon Sep 17 00:00:00 2001 From: autoantwort <41973254+autoantwort@users.noreply.github.com> Date: Wed, 18 Aug 2021 02:33:44 +0200 Subject: [docs] Improve assetcaching.md (#19625) * Improve asset caching readme * Update assetcaching.md Co-authored-by: Robert Schumacher --- docs/users/assetcaching.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'docs/users') diff --git a/docs/users/assetcaching.md b/docs/users/assetcaching.md index 425e1158f..1328bb2fe 100644 --- a/docs/users/assetcaching.md +++ b/docs/users/assetcaching.md @@ -31,7 +31,22 @@ Syntax: `x-azurl,[,[,]]` Adds an Azure Blob Storage source, optionally using Shared Access Signature validation. URL should include the container path and be terminated with a trailing `/`. SAS, if defined, should be prefixed with a `?`. Non-Azure servers will also -work if they respond to GET and PUT requests of the form: ``. +work if they respond to GET and PUT requests of the form: ``. As an example, if you set +`X_VCPKG_ASSET_SOURCES` to `x-azurl,https://mydomain.com/vcpkg/,token=abc123,readwrite` your server should respond to +`GET` and `PUT` requests of the form `https://mydomain.com/vcpkg/?token=abc123`. + +You can also use the filesystem (e.g. a network drive) via `file://` as asset cache. For example you then set +`X_VCPKG_ASSET_SOURCES` to `x-azurl,file:///Z:/vcpkg/assetcache/,,readwrite` when you have a network folder mounted at +`Z:/`. + +The workflow of this asset source is: + +1. Attemp to read from the mirror +2. (If step 1 failed) Read from the original url +3. (If step 2 succeeded) Write back to the mirror + +You can enable/disable steps 1 and 3 via the [``](#valid-source-strings) specifier and you can disable step 2 via +`x-block-origin` below. See also the [binary caching documentation for Azure Blob Storage](binarycaching.md#azure-blob-storage-experimental) for more information on how to set up an `x-azurl` source. -- cgit v1.2.3