strapi-provider-upload-private-azure-storage
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Strapi Provider Upload Azure Storage

NpmVersion NpmDownloads

Overview

This repo is a fork from original strapi-provider-upload-azure-storage repo.

Plugin enabling image uploading to private azure storage container from strapi.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • strapi@4.0.0+

Installing

Inside your strapi project run the following

yarn add strapi-provider-upload-private-azure-storage

# or

npm install strapi-provider-upload-private-azure-storage

Usage

To enable the provider, create or edit the file at ./config/plugins.js.

This is an example plugins.js file for Azure storage:

module.exports = ({ env }) => ({
  upload: {
    config: {
      provider: "strapi-provider-upload-private-azure-storage",
      providerOptions: {
        account: env("STORAGE_ACCOUNT"),
        accountKey: env("STORAGE_ACCOUNT_KEY"),
        serviceBaseURL: env("STORAGE_URL"), // optional
        containerName: env("STORAGE_CONTAINER_NAME"),
        defaultPath: "assets",
        cdnBaseURL: env("STORAGE_CDN_URL"), // optional
        createContainerIfNotExists: true, // optional, defaults to true
      },
    },
  },
});
Property Required Description
account yes Azure account name
accountKey yes Secret access key
serviceBaseURL no Base service URL to be used, optional. Defaults to https://${account}.blob.core.windows.net
containerName yes Container name
defaultPath yes The path to use when there is none being specified. Defaults to assets
cdnBaseURL no CDN base url
createContainerIfNotExisits no Indicates whether the plugin should create the specified container if it doesn't exist.

Security Middleware Configuration

Due to the default settings in the Strapi Security Middleware you will need to modify the contentSecurityPolicy settings to properly see thumbnail previews in the Media Library. You should replace strapi::security string with the object bellow instead as explained in the middleware configuration documentation.

To allow the azure storage content to be displayed, edit the file at ./config/middlewares.ts. You should replace the strapi::security string with the object below instead, see the Middlewares configuration documentation for more details.

./config/middlewares.ts

// This code supposes azurite runs in docker in local on port 10000. Adjust as necessary.
const storageDomain = (process.env.AZURE_STORAGE_ACCOUNT && `${process.env.AZURE_STORAGE_ACCOUNT}.blob.core.windows.net/`) || 'host.docker.internal:10000'

export default [
  // ...
  {
    name: 'strapi::security',
    config: {
      contentSecurityPolicy: {
        useDefaults: true,
        directives: {
          "connect-src": ["'self'", "https:"],
          "img-src": ["'self'", "data:", "blob:", "dl.airtable.com", "market-assets.strapi.io", storageDomain],
          "media-src": ["'self'", "data:", "blob:", "dl.airtable.com", "market-assets.strapi.io", storageDomain],
          upgradeInsecureRequests: null,
        },
      },
    }
  },
  // ...
];

serviceBaseURL is optional, it is useful when connecting to Azure Storage API compatible services, like the official emulator Azurite. serviceBaseURL would then look like http://localhost:10000/your-storage-account. When serviceBaseURL is not provided, default https://${account}.blob.core.windows.net will be used. When running Azurite in Docker, serviceBaseURL should be used with a URL that looks like : http://host.docker.internal:10000

cdnBaseURL is optional, it is useful when using CDN in front of your storage account. Images will be returned with the CDN URL instead of the storage account URL.

createContainerIfNotExists is optional, and defaults to true. The container will be created as private.

Contributing

Contributions are welcome

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • strapi.io
  • Azure

Readme

Keywords

Package Sidebar

Install

npm i strapi-provider-upload-private-azure-storage

Homepage

strapi.io

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

24.2 kB

Total Files

9

Last publish

Collaborators

  • fperreault