1.0.8 • Published 2 years ago

strapi-provider-aws-s3-cloudfront-cdn v1.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

strapi-provider-aws-s3-cloudfront-cdn

So this is a "scratch your own itch" kinda package. It is an "AWS S3 with Cloudfront" upload provider for the wonderful Strapi Open Source Node.js Headless CMS v4. This package exists simply because the official provider package does not currently support serving S3 assets via Cloufront CDN.

It is a copy of this package with the (tiny) Cloudfront addition. The text below is also mostly copied from Strapi's official provider plugin. If you need help setting it up, check the official documentation first :-)

Please refer to this Strapi official README for details.

Installation

# using yarn
yarn add strapi-provider-aws-s3-cloudfront-cdn

# using npm
npm install strapi-provider-aws-s3-cloudfront-cdn --save

Provider Configuration

./config/plugins.js:

module.exports = ({ env }) => ({
  // ...
  upload: {
    config: {
      provider: "strapi-provider-aws-s3-cloudfront-cdn",
      providerOptions: {
        accessKeyId: env("AWS_ACCESS_KEY_ID"),
        secretAccessKey: env("AWS_ACCESS_SECRET"),
        region: env("AWS_REGION"),
        params: {
          Bucket: env("AWS_BUCKET"),
        },
        cdn: env("AWS_CLOUDFRONT_URL"), // eg. https://xyz.cloudfront.net (no trailing slash)
      },
      actionOptions: {
        upload: {},
        uploadStream: {},
        delete: {},
      },
    },
  },
  // ...
});

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.

./config/middlewares.js

module.exports = [
  // ...
  {
    name: "strapi::security",
    config: {
      contentSecurityPolicy: {
        useDefaults: true,
        directives: {
          "connect-src": ["'self'", "https:"],
          "img-src": [
            "'self'",
            "data:",
            "blob:",
            "dl.airtable.com",
            "yourBucketName.s3.yourRegion.amazonaws.com",
            "yourCloudfrontDomain", // eg. xyz.cloudfront.net
          ],
          "media-src": [
            "'self'",
            "data:",
            "blob:",
            "dl.airtable.com",
            "yourBucketName.s3.yourRegion.amazonaws.com",
            "yourCloudfrontDomain", // eg. xyz.cloudfront.net
          ],
          upgradeInsecureRequests: null,
        },
      },
    },
  },
  // ...
];

If you use dots in your bucket name, the url of the ressource is in directory style (s3.yourRegion.amazonaws.com/your.bucket.name/image.jpg) instead of yourBucketName.s3.yourRegion.amazonaws.com/image.jpg. Then only add s3.yourRegion.amazonaws.com to img-src and media-src directives.

Required AWS Policy Actions

These are the minimum amount of permissions needed for this provider to work.

"Action": [
  "s3:PutObject",
  "s3:GetObject",
  "s3:ListBucket",
  "s3:DeleteObject",
  "s3:PutObjectAcl"
],