Resizes images uploaded to Cloud Storage to a specified size, and optionally keeps or deletes the original image.
How this extension works
Use this extension to create resized versions of an image uploaded to a Cloud Storage bucket.
When you upload an image file to your specified Cloud Storage bucket, this extension:
- Creates a resized image with your specified dimensions.
- Names the resized image using the same name as the original uploaded image, but suffixed with your specified width and height.
- Stores the resized image in the same Storage bucket as the original uploaded image.
You can even configure the extension to create resized images of different dimensions for each original image upload. For example, you might want images that are 200x200, 400x400, and 680x680 - this extension can create these three resized images then store them in your bucket.
The extension automatically copies the following metadata, if present, from the original image to the resized image(s):
Content-Type, and user-provided metadata (a new Firebase storage download token will be generated on the resized image(s) if the original metadata contains a token). Note that you can optionally configure the extension to overwrite the
Cache-Control value for the resized image(s).
Detailed configuration information
To configure this extension, you specify a maximum width and a maximum height (in pixels, px). This extension keeps the aspect ratio of uploaded images constant and shrinks the image until the resized image's dimensions are at or under your specified max width and height.
For example, say that you specify a max width of 200px and a max height of 100px. You upload an image that is 480px wide by 640px high, which means a 0.75 aspect ratio. The final resized image will be 75px wide by 100px high to maintain the aspect ratio while also being at or under both of your maximum specified dimensions.
Before installing this extension, make sure that you've set up a Cloud Storage bucket in your Firebase project.
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
- Cloud Storage
- Cloud Functions
When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. Learn more about Firebase billing.
What you can configure
- Cloud Functions location
- Cloud Storage bucket for images
- Sizes of resized images
- Deletion of original file
- Cloud Storage path for resized images
- Cache-Control header for resized images
Type: Cloud Function
Description: Listens for new images uploaded to your specified Cloud Storage bucket, resizes the images, then stores the resized images in the same bucket. Optionally keeps or deletes the original images.
How to install this extension
Using the Firebase console
To install and manage extensions, you can use the Firebase console.Install using console
Using the Firebase CLI
To install and manage extensions, you can also use the Firebase CLI:
Step 1: Run the following npm command to install the CLI or update to the latest CLI version.
npm install -g firebase-toolsDoesn't work? Take a look at the Firebase CLI reference or change your npm permissions.
Step 2: Install this extension by running the following command
firebase ext:install storage-resize-images --project=projectId_or_alias