Browse Source

Update docs

DarthSim 2 years ago
parent
commit
8326369cb9
2 changed files with 23 additions and 17 deletions
  1. 2 2
      docs/generating_the_url.md
  2. 21 15
      docs/serving_files_from_azure_blob_storage.md

+ 2 - 2
docs/generating_the_url.md

@@ -127,8 +127,8 @@ Default: `0`
 zoom:%zoom_x_y
 zoom:%zoom_x_y
 z:%zoom_x_y
 z:%zoom_x_y
 
 
-zoom:%zoom_x %zoom_y
-z:%zoom_x %zoom_y
+zoom:%zoom_x:%zoom_y
+z:%zoom_x:%zoom_y
 ```
 ```
 
 
 When set, imgproxy will multiply the image dimensions according to these factors. The values must be greater than 0.
 When set, imgproxy will multiply the image dimensions according to these factors. The values must be greater than 0.

+ 21 - 15
docs/serving_files_from_azure_blob_storage.md

@@ -3,14 +3,17 @@
 imgproxy can process images from Azure Blob Storage containers. To use this feature, do the following:
 imgproxy can process images from Azure Blob Storage containers. To use this feature, do the following:
 
 
 1. Set `IMGPROXY_USE_ABS` environment variable to `true`
 1. Set `IMGPROXY_USE_ABS` environment variable to `true`
-2. Set `IMGPROXY_ABS_NAME` to your Azure account name and `IMGPROXY_ABS_KEY` to your Azure account key
+2. Set `IMGPROXY_ABS_NAME` to your Azure account name
+3. [Set up the necessary credentials](#set-up-credentials)
 4. _(optional)_ Specify the Azure Blob Storage endpoint with `IMGPROXY_ABS_ENDPOINT`
 4. _(optional)_ Specify the Azure Blob Storage endpoint with `IMGPROXY_ABS_ENDPOINT`
-4. Use `abs://%bucket_name/%file_key` as the source image URL
+5. Use `abs://%bucket_name/%file_key` as the source image URL
+
+## Set up credentials
 
 
 ### Leverage Azure Managed Identity or Service Principal
 ### Leverage Azure Managed Identity or Service Principal
 
 
 Microsoft encourages the use of a Managed Identity or Service Principal when accessing resources on an Azure Storage Account.
 Microsoft encourages the use of a Managed Identity or Service Principal when accessing resources on an Azure Storage Account.
-Both of these authentication pathways are supported out-of-the box.
+Both of these authentication pathways are supported out of the box.
 
 
 #### Managed Identity
 #### Managed Identity
 
 
@@ -18,21 +21,24 @@ There is no additional configuration required so long as the resource that imgpr
 
 
 #### Service Principal
 #### Service Principal
 
 
-Please refer to the [following documentation](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal)
-on creation of a service principal before proceeding.
+Please, refer to the [following documentation](https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal) on the creation of a service principal before proceeding.
 
 
 Once that step is completed, the following environment variables must be configured depending on which option was chosen.
 Once that step is completed, the following environment variables must be configured depending on which option was chosen.
 
 
-##### Secret Authentication
+For secret authentication:
+
+* `AZURE_CLIENT_ID`: the client ID for your application registration
+* `AZURE_TENANT_ID`: the tenant ID for your application registration
+* `AZURE_CLIENT_SECRET`: the client secret for your application registration
+
+For certificate authentication:
 
 
-* `AZURE_CLIENT_ID`: Specifies the client ID for your application registration 
-* `AZURE_TENANT_ID`: Specifies the tenant ID for your application registration 
-* `AZURE_CLIENT_SECRET`: Specifies the client secret for your application registration.
+* `AZURE_CLIENT_ID`: the client ID for your application registration
+* `AZURE_TENANT_ID`: the tenant ID for your application registration
+* `AZURE_CLIENT_CERTIFICATE_PATH`: the path to a PFX or PEM-encoded certificate including private key
+* `AZURE_CLIENT_CERTIFICATE_PASSWORD`: _(optional)_ the password protecting the certificate file (PFX (PKCS12))
+* `AZURE_CLIENT_CERTIFICATE_CHAIN`: _(optional)_ send certificate chain in x5c header to support subject name / issuer-based authentication
 
 
-##### Certificate Authentication
+### Using Storage Account Key
 
 
-* `AZURE_CLIENT_ID`: Specifies the client ID for your application registration 
-* `AZURE_TENANT_ID`: Specifies the tenant ID for your application registration 
-* `AZURE_CLIENT_CERTIFICATE_PATH`: Specifies the path to a PFX or PEM-encoded certificate including private key 
-* `AZURE_CLIENT_CERTIFICATE_PASSWORD`: (optional) the password protecting the certificate file (PFX (PKCS12))
-* `AZURE_CLIENT_CERTIFICATE_CHAIN`: (optional) send certificate chain in x5c header to support subject name / issuer-based authentication
+Alternatively, you can set `IMGPROXY_ABS_KEY` to your Azure Blob Storage account key. See the [Manage storage account access keys](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage) guide for more info.