Skip to main content

​
Install the Package

Install payload-cloudinary using your preferred package manager: 
npm install payload-cloudinary

​
Peer Dependencies

This plugin requires the following peer dependencies:
  • payload ^2.0.0
  • typescript ^5.0.0
Most Payload CMS projects will already have these dependencies installed. The plugin will automatically use your existing Payload and TypeScript installations.

​
Node Version Requirement

Ensure you’re running Node.js version 18.0.0 or higher: 
node --version

​
Configure Environment Variables

Create or update your .env file with your Cloudinary credentials:
.env
CLOUDINARY_CLOUD_NAME=your_cloud_name
CLOUDINARY_API_KEY=your_api_key
CLOUDINARY_API_SECRET=your_api_secret
Never commit your .env file to version control. Add it to your .gitignore file to keep your credentials secure.

​
Getting Your Cloudinary Credentials

You can find your Cloudinary credentials in your Cloudinary Console Dashboard:
  1. Log in to your Cloudinary account
  2. Navigate to the Dashboard
  3. Your Cloud Name, API Key, and API Secret are displayed in the “Account Details” section
If you don’t have a Cloudinary account yet, you can sign up for free to get started.

​
TypeScript Configuration

This plugin is built with TypeScript and includes full type definitions. No additional TypeScript configuration is required.

​
Next Steps

Quickstart Guide

Get up and running with a basic configuration

Configuration

Explore all available configuration options

Build docs developers (and LLMs) love

Get started for freeTalk to us