Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudinary-community/netlify-plugin-cloudinary
Supercharge images on your Netlify site with Cloudinary!
https://github.com/cloudinary-community/netlify-plugin-cloudinary
cloudinary hacktoberfest netlify netlify-plugin
Last synced: about 1 month ago
JSON representation
Supercharge images on your Netlify site with Cloudinary!
- Host: GitHub
- URL: https://github.com/cloudinary-community/netlify-plugin-cloudinary
- Owner: cloudinary-community
- License: mit
- Created: 2021-11-25T01:52:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T17:20:12.000Z (9 months ago)
- Last Synced: 2024-05-01T21:20:05.893Z (8 months ago)
- Topics: cloudinary, hacktoberfest, netlify, netlify-plugin
- Language: HTML
- Homepage: https://netlify.cloudinary.dev/
- Size: 6.34 MB
- Stars: 40
- Watchers: 8
- Forks: 18
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
######
# Cloudinary Netlify Plugin
Optimize and serve all images served in your Netlify site deploy with [Cloudinary](https://cloudinary.com/).
The Cloudinary plugin hooks into your Netlify build process and sets up images for optimization and delivery. First, the plugin replaces all your on-page, post-compilation images with a Cloudinary-sourced URL, greatly accelerating your initial page load. Next, for comprehensive coverage, Cloudinary redirects assets requested from your images directory to a Cloudinary URL with the default fetch feature or the upload delivery type.
tl;dr automatically serves smaller images in modern formats
- [Getting Started](#%EF%B8%8F-getting-started)
- [Configuration](#-configuration)
- [Common Questions & Issues](#%EF%B8%8F%EF%B8%8F-common-questions--issues)
- [How It Works](#%EF%B8%8F-how-it-works)
- [Development](#-development)
**This is a community library supported by the Cloudinary Developer Experience team.**
## ⚡️ Getting Started
Before installing, make sure you're set up with a free [Cloudinary](https://cloudinary.com/) account.
### Installing via Netlify UI
- [Install the plugin](https://app.netlify.com/plugins/netlify-plugin-cloudinary/install) using the [Netlify Build Plugins Directory](https://app.netlify.com/plugins)
- Add your Cloudinary Cloud Name as a [build environment variable](https://docs.netlify.com/configure-builds/environment-variables)
```
Name: CLOUDINARY_CLOUD_NAME
Value:
```
- Trigger a new deployment!
By default, your images will be served via the [fetch delivery type](https://cloudinary.com/documentation/fetch_remote_images).
### File-based configuration
- Add the plugin to your Netlify config:
```toml
[[plugins]]
package = "netlify-plugin-cloudinary"
```
- Configure your Cloudinary Cloud Name:
```toml
[[plugins]]
package = "netlify-plugin-cloudinary"
[plugins.inputs]
cloudName = ""
```
By default, your images will be served via the [fetch delivery type](https://cloudinary.com/documentation/fetch_remote_images).
### Installing locally
- Install the plugin:
```shell
npm install netlify-plugin-cloudinary
```
- Use a [file-based configuration](#file-based-configuration) to add the plugin to your builds
## 🛠 Configuration
### Plugin Inputs
| Name | Type |Required | Example | Description |
|-----------------|---------|---------|-----------| ------------|
| cloudName | string | No* | mycloud | Cloudinary Cloud Name |
| cname | string | No | domain.com | The custom domain name (CNAME) to use for building URLs (Advanced Plan Users) |
| deliveryType | string | No | fetch | The method by which Cloudinary stores and delivers images (Ex: fetch, upload) |
| folder | string | No | myfolder | Folder all media will be stored in. Defaults to Netlify site name |
| imagesPath | string/Array | No | /assets | Local path application serves image assets from |
| loadingStrategy | string | No | eager | The method in which in which images are loaded (Ex: lazy, eager) |
| maxSize | object | No | eager | See Below. |
| privateCdn | boolean | No | true | Enables Private CDN Distribution (Advanced Plan Users) |
| uploadPreset | string | No | my-preset | Defined set of asset upload defaults in Cloudinary |
| uploadConcurrency | number | No | 10 | Maximum value of concurrent uploads |
*Cloud Name must be set as an environment variable if not as an input
#### Max Size
The Max Size option gives you the ability to configure a maximum width and height that images will scale down to, helping to avoid serving unnecessarily large images.
By default, the aspect ratio of the images are preserved, so by specifying both a maximum width and height, you're telling Cloudinary to scale the image down so that neither the width or height are beyond that value.
Additionally, the plugin uses a crop method of `limit` which avoids upscaling images if the images are already smaller than the given size, which reduces unnecessary upscaling as the browser will typically automatically handle.
The options available are:
| Name | Type | Example | Description |
|-----------------|---------|-----------| ------------|
| dpr | string | 2.0 | Device Pixel Ratio which essentially multiplies the width and height for pixel density. |
| height | number | 600 | Maximum height an image can be delivered as. |
| width | number | 800 | Maximum width an image can be delivered as. |
It's important to note that this will not change the width or height attribute of the image within the DOM, this will only be the image that is being delivered by Cloudinary.
### Environment Variables
| Name | Required | Example | Description |
|------------------------|----------|----------|-------------|
| CLOUDINARY_CLOUD_NAME | No* | mycloud | Cloudinary Cloud Name |
| CLOUDINARY_API_KEY | No | 1234 | Cloudinary API Key |
| CLOUDINARY_API_SECRET | No | abcd1234 | Cloudinary API Secret |
*Cloud Name must be set as an input variable if not as an environment variable
### Setting your Cloud Name
You have two options for setting your Cloud Name: plugin input or environment variable.
**Input**
Inside your Netlify config:
```toml
[plugins.inputs]
cloudName = ""
```
**Environment Variable**
Inside your environment variable configuration:
```
CLOUDINARY_CLOUD_NAME=""
```
Learn how to [set environment variables with Netlify](https://docs.netlify.com/configure-builds/environment-variables/).
### Changing your Delivery Type
**fetch**
Default - no additional configuration needed.
The fetch method allows you to use Cloudinary delivery by providing a remote URL. Learn more about using delivering remote images with [fetch](https://cloudinary.com/documentation/fetch_remote_images).
> Note: if you are currently restricting Fetched URLs, you need to ensure your Netlify URL is listed under allowed fetch domains. Older accounts may restrict fetched images by default. Read more about [restricting the allowed fetch domains](https://cloudinary.com/documentation/fetch_remote_images#restricting_the_allowed_fetch_domains).
**upload - Unsigned**
Unsigned uploads require an additional [Upload Preset](https://cloudinary.com/documentation/upload_presets) set up and configured in your Cloudinary account.
Inside your Netlify config:
```toml
[[plugins]]
package = "netlify-plugin-cloudinary"
[plugins.inputs]
cloudName = "[Your Cloudinary Cloud Name]"
deliveryType = "upload"
uploadPreset = "[Your Cloudinary Upload Preset]"
```
Uploading media to Cloudinary gives you more flexibility with your media upon delivery. Learn more about [unsigned uploads](https://cloudinary.com/documentation/upload_images#unsigned_upload).
**upload - Signed**
Signed uploads require you to set your API Key and API Secret as environment variables.
Inside your Netlify config:
```toml
[[plugins]]
package = "netlify-plugin-cloudinary"
[plugins.inputs]
cloudName = "[Your Cloudinary Cloud Name]"
deliveryType = "upload"
```
Inside your environment variable configuration:
```
CLOUDINARY_API_KEY="[Your Cloudinary API Key]"
CLOUDINARY_API_SECRET="[Your Cloudinary API Secret]"
```
Uploading media to Cloudinary gives you more flexibility with your media upon delivery. Learn more about [signed uploads](https://cloudinary.com/documentation/upload_images#uploading_assets_to_the_cloud).
### Customizing where your images are served from
By default, the plugin will attempt to serve any thing served from /images as Cloudinary paths. This can be customized by passing in the `imagesPath` input.
Inside your Netlify config:
```toml
[[plugins]]
package = "netlify-plugin-cloudinary"
[plugins.inputs]
cloudName = "[Your Cloudinary Cloud Name]"
imagesPath = "/my-path"
# or imagesPath = [ "/my-path", "/my-other-path" ]
```
## 🕵️♀️ Common Questions & Issues
### I'm using the default settings but my images 404
The plugin uses the fetch method by default and if you're receiving a 404 with a valid URL and valid Cloudinary account, you may be currently restricting fetched URLs.
You have two options to resolve this: adding your Netlify domain to the list of "allowed fetch domains" and removing the fetched URL restriction.
Adding your domain to the "allowed fetch domains" list is more secure by not allowing others to use your Cloudinary account with their own images. You can do this under Settings > Security > Allowed fetch domains.
Alternatively, you can remove the restriction and allow all fetched images to work by going to Settings > Security > Restricted media types and unchecking the box for Fetched URL.
## ⚙️ How It Works
### Delivery Part 1: Replacing all static, on-page images with Cloudinary URLs
During the Netlify build process, the plugin is able to tap into the `onPostBuild` hook where we use [jsdom](https://github.com/jsdom/jsdom) to create a node-based representation of the DOM for each output HTML file, then walk through each node, and if it's an image, we replace the source with a Cloudinary URL.
Depending on the configuration, we'll either use the full URL for that image with the [Cloudinary fetch API](https://cloudinary.com/documentation/fetch_remote_images) or alternatively that image will be [uploaded](https://cloudinary.com/documentation/upload_images), where then it will be served by public ID from the Cloudinary account.
While this works great for a lot of cases and in particular the first load of that page, using a framework with clientside routing or features that mutate the DOM may prevent that Cloudinary URL from persisting, making all of that hard work disappear, meaning it will be served from the Netlify CDN or original remote source (which is fine, but that leads us to Part 2).
### Delivery Part 2: Serving all assets from the /images directory from Cloudinary
To provide comprehensive coverage of images being served from Cloudinary, we take advantage of Netlify's dynamic redirects and serverless functions to map any image being served from the /images directory (or the configured `imagesPath`), redirect it to a serverless function, which then gets redirected to a Cloudinary URL.
Through this process, we're still able to afford the same option of using either the fetch or upload API depending on preference, where the latter would be uploaded if it's a new asset within the serverless function.
## 🧰 Development
### Plugin
To actively develop with the plugin, you need to be able to run a Netlify build and deploy.
You can do this by pushing a site that uses this plugin to Netlify or you can use the [Netlify CLI](https://docs.netlify.com/cli/get-started/) locally (recommended).
You can reference the plugin locally in your `netlify.toml` by specifying the directory the plugin is in relative to your project, for example:
```
[[plugins]]
package = "../netlify-plugin-cloudinary"
```
On the locally linked Netlify project, you can then run:
```
netlify deploy --build
```
Which will combine the build and deploy contexts and run through the full process, generating a preview URL.
#### Caveats
* The Netlify CLI doesn't support all input and environment variables for build plugins, primarily `process.env.DEPLOY_PRIME_URL` meaning the `onPostBuild` image replacement will not occur locally.
### Demo
The repository additionally includes a demo that uses the plugin. The demo is a simple Next.js application that lows a few images statically and those same images in a separate list once the page loads. This helps us test both the on-page image replacement and the redirecting of the images directory.
You can link this project to your Netlify account for testing purposes by creating a new Netlify site at the root of this project and linking it to that new site.
Once linked, you can then run the build and deploy process with:
```
netlify deploy --build
```
### Tests
Tests require all environment variables to be actively set pass. See [configuration](#-configuration) above to see which variables need to be set.
Once set, tests can be run with:
```
npm run test
```
## Contributors
Colby Fayock
💻 📖 💡
William
💻
Matt Kane
👀
Elisha Hollander
💻
Kunal Kaushik
🔧
Shikhar
💻 ⚠️
Diganta Kr Banik
💻 📖 ⚠️
3t8
📖
Abubakrce19
📖
Erica Pisani
💻
Matías Hernández Arellano
💻
Kieran Klukas
💻
Gretchen Shelby-Dormer
💻