Strapi plugin logo for Firebase Storage

Firebase Storage

A provider to override the upload process to send files to Firebase Storage.

Strapi Provider Firebase Storage

This is a Strapi provider that will upload your files to Firebase Storage.

Installation

1
npm install strapi-provider-firebase-storage

Note on CORS options

You may run into an issue displaying the image where CORS is blocking it. If that happens open ./config/middwares.js and replace strapi::security with this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  name: "strapi::security",
  config: {
    contentSecurityPolicy: {
      useDefaults: true,
      directives: {
        "connect-src": ["'self'", "https:"],
        "img-src": [
          "'self'",
          "data:",
          "blob:",
          "storage.googleapis.com",
          "dl.airtable.com",
        ],
        "media-src": [
          "'self'",
          "data:",
          "blob:",
          "storage.googleapis.com",
          "dl.airtable.com",
        ],
        upgradeInsecureRequests: null,
      },
    },
  },
},

It will whitelabel images coming from Google Cloud Storage in the CORS settings.

Usage

Here is a sample usage:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
module.exports = ({ env }) => {
  return {
    ...
    upload: {
      config: {
        provider: "strapi-provider-firebase-storage",
        providerOptions: {
          serviceAccount: require("path/to/my/serviceAccount.json"),
          // Custom bucket name
          bucket: env(
            "STORAGE_BUCKET_URL",
            "my-bucket-name.appspot.com"
          ),
          sortInStorage: true, // true | false
          debug: false, // true | false
        },
      },
    },
    ...
  };
};

Config Options

OptionIs RequiredDefaultNotes
serviceAccounttruenoneThis is just the path to your service account file
bucketfalsenoneIf you leave this blank it should go to your default bucket, but I'd recommend putting your default bucket name anyway
sortInStoragefalsetrueThis will sort files in your firebase storage bucket into folders
debugfalsefalseThis will just log all the steps to the console

Notes on the sortInStorage option

By default Strapi will just output all the files in the default bucket with no folder structure (even if you make folders in the Strapi admin UI). Strapi also creates variants of files (like iamges ex. thumbnails) so if you upload an image to Strapi you'll actually have like a few variants of it actually uploaded to Firebase.

If you were to look at that in Firebase it would look like total chaos. So what I did was create a couple of functions that will upload your files based on mime type as well as sort all variants of an image under a single folder. If you wanted to do something else with those images (for example create triggers for uploads for specific folders) they will be sorted nicely for you.

Alos be really careful toggling the sortInStorage option. If you have it on, upload some files, then turn it off the delete function could break for the files that were uploaded when it was turned on.

Install now

npm install strapi-provider-firebase-storage

STATS

No GitHub star yet90 weekly downloads

Last updated

263 days ago

Strapi Version

Unavailable

Author

github profile image for Sam Redmond
Sam Redmond

Related plugin

Upload

Useful links

Create your own plugin

Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.