AndyButland / Our.Umbraco.StorageProviders.AWSS3

An implementation of the Umbraco IFileSystem connecting your Umbraco Media section to an AWS S3 Storage bucket featuring middleware serving up media files from the `/media` path and ImageSharp image provider/cache.

Our.Umbraco.StorageProviders.AWSS3

The AWS S3 Storage provider has an implementation of the Umbraco IFileSystem that connects to an AWS S3 Storage container.

It also has the following features:

• middleware for serving media files from the /media path with support for the image cache with files in the /cache path
• ImageSharp image provider

Usage

This provider can be added in the Startup.cs file:

public void ConfigureServices(IServiceCollection services)
{
    services.AddUmbraco(_env, _config)
        .AddBackOffice()
        .AddWebsite()
        .AddComposers()
        // Add the AWS S3 Storage file system
        .AddAWSS3MediaFileSystem()
        .Build();
}

public void Configure(IApplicationBuilder app)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseUmbraco()
        .WithMiddleware(u =>
        {
            u.UseBackOffice();
            u.UseWebsite();
            // Enables the AWS S3 Storage middleware for Media
            u.UseAWSS3MediaFileSystem();

        })
        .WithEndpoints(u =>
        {
            u.UseInstallerEndpoints();
            u.UseBackOfficeEndpoints();
            u.UseWebsiteEndpoints();
        });
}

In attempt to pare down the configuration and leverage AWS practices with the AWSSDK.Extensions.NETCore.Setup dependency, the settings for this storage require only the S3 bucket name in appsettings.json:

{
  "Umbraco": {
    "Storage": {
      "AWSS3": {
        "Media": {
          "BucketName": ""
        }
      }
    }
  }
}

If Umbraco is not running in a container under an IAM policy, appsettings.json will likely need to include an AWS block:

{
  "AWS": {
    "Profile": "local-test-profile",
    "Region": "us-west-2"
  }
}

Further information for this settings block can be found in the AWS documentation here.

Folder structure in the AWS S3 Storage container

With an S3 bucket in place, the media folder will contain the traditional seen media folders and files while the cache folder will contain the files to support the image cache.

Bugs, issues and Pull Requests

If you encounter a bug when using this client library please open an issue in the issue tracker of this repository.

If you are interested in contributing, a Pull Request is always welcome. Please feel free to open an issue before submitting a Pull Request to discuss what you would like to submit.

License

Umbraco Storage Provider for AWS S3 is MIT licensed.

Acknowlegements

This project would not have been possible without the work done by those developers along the fork path.