Blob Storage Configuration

The BlobStorage configuration section defines how an application stores and retrieves files.

File System

Stores files in the file system. Available settings:

• Path: the path to where the files will be stored.

Example (environment variables):

BlobStorage__Type=FileSystem
BlobStorage__Path=/var/files/myapp

Example (.ini or .conf file):

[BlobStorage]
Type=FileSystem
Path=/var/files/myapp

Example (JSON configuration):

{
    ...,
    "BlobStorage": {
        "Type": "FileSystem"
        "Path": "/var/files/myapp"
    },
    ...
}

Azure Storage Account

Stores files in an Azure Storage Account Container. Available settings:

• ConnectionString: the connection string for the Storage account.
• ContainerName: the name of the container where the files will be stored.

Example (environment variables):

BlobStorage__Type=Azure
BlobStorage__ConnectionString=DefaultEndpointsProtocol=https;AccountName=myaccountname;AccountKey=myaccountkey;EndpointSuffix=core.windows.net
BlobStorage__ContainerName=myapp-container

Example (.ini or .conf file):

[BlobStorage]
Type=Azure
ConnectionString="DefaultEndpointsProtocol=https;AccountName=myaccountname;AccountKey=myaccountkey;EndpointSuffix=core.windows.net"
ContainerName=myapp-container

Example (JSON configuration):

{
    ...
    "BlobStorage": {
        "Type": "Azure",
        "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=myaccountname;AccountKey=myaccountkey;EndpointSuffix=core.windows.net",
        "ContainerName": "myapp-container"
    },
    ...
}

AWS S3 (Simple Storage Service)

Stores files in an S3 Bucket. Available settings:

• Region: the region of the bucket.
• BucketName: the name of the Bucket where the files will be stored.
• AccessKey: the access key ID of an IAM user that has access to the bucket.
• SecretKey: the secret access key of an IAM user that has access to the bucket.

Example (environment variables):

BlobStorage__Type=AwsS3
BlobStorage__Region=us-east-1
BlobStorage__BucketName=myappbucket
BlobStorage__AccessKey=MYACCESSKEYID
BlobStorage__SecretKey=MYSECRETACCESSKEY

Example (.ini or .conf file):

[BlobStorage]
Type=AwsS3
Region=us-east-1
BucketName=myappbucket
AccessKey=MYACCESSKEYID
SecretKey=MYSECRETACCESSKEY

Example (JSON configuration):

{
    ...
    "BlobStorage": {
        "Type": "AwsS3",
        "Region": "us-east-1",
        "BucketName": "myappbucket",
        "AccessKey": "MYACCESSKEYID",
        "SecretKey": "MYSECRETACCESSKEY"
    },
    ...
}

S3-compatible object storage

A self-hosted s3-compatible object storage service, also known as an "s3 clone", may also be used, for instance minIO. In this case, instead of the Region, specify the Endpoint.

Example (environment variables):

BlobStorage__Type=AwsS3
BlobStorage__Endpoint=http://localhost:9000
BlobStorage__BucketName=myappbucket
BlobStorage__AccessKey=MYACCESSKEYID
BlobStorage__SecretKey=MYSECRETACCESSKEY

Example (.ini or .conf file):

[BlobStorage]
Type=AwsS3
Endpoint=http://localhost:9000
BucketName=myappbucket
AccessKey=MYACCESSKEYID
SecretKey=MYSECRETACCESSKEY

Example (JSON configuration):

{
    ...
    "BlobStorage": {
        "Type": "AwsS3",
        "Endpoint": "http://localhost:9000",
        "BucketName": "myappbucket",
        "AccessKey": "MYACCESSKEYID",
        "SecretKey": "MYSECRETACCESSKEY"
    },
    ...
}

By default, path-style addressing is used when an S3-compatible storage is configured, instead of the default virtual-hosted–style addressing used when a standard AWS S3 bucket is configured. This can be changed with the ForcePathStyle setting (true or false). For more information on S3 addressing, see Virtual hosting of buckets.