azure: tweak documentation for endpoint suffix

This commit is contained in:
Michael Eischer 2023-07-07 23:09:44 +02:00
parent 068b115abc
commit e36d17a6f8
4 changed files with 11 additions and 6 deletions

View file

@ -1,6 +1,10 @@
Enhancement: Add support for non-global Azure clouds
Restic backups on azure only worked for storages on the global domain `core.windows.net`. This meant that backups to other domains such as Azure China (`core.chinacloudapi.cn') were not supported. Restic now allows overriding the global domain using the environment variable `AZURE_ENDPOINT_SUFFIX'.
Restic backups on Azure only supported storages using the global domain
`core.windows.net`. This meant that backups to other domains such as Azure
China (`core.chinacloudapi.cn') or Azure Germany (`core.cloudapi.de`) were
not supported. Restic now allows overriding the global domain using the
environment variable `AZURE_ENDPOINT_SUFFIX'.
https://github.com/restic/restic/issues/2468
https://github.com/restic/restic/pull/4387

View file

@ -537,12 +537,12 @@ or
$ export AZURE_ACCOUNT_NAME=<ACCOUNT_NAME>
$ export AZURE_ACCOUNT_SAS=<SAS_TOKEN>
Restic will use Azure's global domain ``core.windows.net`` by default. You can specify other
domains to be used like so:
Restic will by default use Azure's global domain ``core.windows.net`` as endpoint suffix.
You can specify other suffixes as follows:
.. code-block:: console
$export AZURE_ENDPOINT_SUFFIX=<ENDPOINT_SUFFIX>
$ export AZURE_ENDPOINT_SUFFIX=<ENDPOINT_SUFFIX>
Afterwards you can initialize a repository in a container called ``foo`` in the
root path like this:

View file

@ -614,7 +614,7 @@ environment variables. The following lists these environment variables:
AZURE_ACCOUNT_NAME Account name for Azure
AZURE_ACCOUNT_KEY Account key for Azure
AZURE_ACCOUNT_SAS Shared access signatures (SAS) for Azure
AZURE_ENDPOINT_SUFFIX Domain of Azure Storage (default: core.windows.net)
AZURE_ENDPOINT_SUFFIX Endpoint suffix for Azure Storage (default: core.windows.net)
GOOGLE_PROJECT_ID Project ID for Google Cloud Storage
GOOGLE_APPLICATION_CREDENTIALS Application Credentials for Google Cloud Storage (e.g. $HOME/.config/gs-secret-restic-key.json)

View file

@ -72,7 +72,8 @@ func (cfg *Config) ApplyEnvironment(prefix string) {
if cfg.AccountSAS.String() == "" {
cfg.AccountSAS = options.NewSecretString(os.Getenv(prefix + "AZURE_ACCOUNT_SAS"))
}
if cfg.EndpointSuffix == "" {
cfg.EndpointSuffix = os.Getenv("AZURE_ENDPOINT_SUFFIX")
cfg.EndpointSuffix = os.Getenv(prefix + "AZURE_ENDPOINT_SUFFIX")
}
}