An open API service indexing awesome lists of open source software.

https://github.com/strapi-community/cloudinary-media-library

Strapi Cloudinary Media Library Custom Field
https://github.com/strapi-community/cloudinary-media-library

cloudinary custom-field media-library strapi strapi-plugin

Last synced: 4 months ago
JSON representation

Strapi Cloudinary Media Library Custom Field

Awesome Lists containing this project

README

          


Logo - Strapi cloudinary-media-library Plugin


Strapi Cloudinary Media Library Plugin


Strapi Custom Field with Cloudinary Media Library feature



NPM version


Monthly download on NPM


codecov.io

---


UI preview

A Strapi plugin that adds a **custom field** for selecting Cloudinary media assets using Cloudinary's official Media Library widget.

## πŸ“‹ Table of Contents

- [✨ Features](#features)
- [πŸ“‹ Requirements](#requirements)
- [πŸ“¦ Installation](#installation)
- [πŸ” Getting Cloudinary Credentials](#getting-cloudinary-credentials)
- [βš™οΈ Setting up Configuration File](#setting-up-configuration-file)
- [πŸ”’ Managing Permissions](#managing-permissions)
- [πŸ‘¨β€πŸ’» Development & Testing](#development--testing)
- [πŸ”— Links](#links)
- [πŸ’¬ Community Support](#community-support)
- [πŸ“„ License](#license)

## ✨ Features

- Seamlessly integrate Cloudinary Media Library into Strapi admin panel
- Select and manage media assets directly from Cloudinary
- Custom field for Cloudinary media assets
- Support for images, videos and other media types
- **Automatically includes Cloudinary media URLs and metadata in Strapi API responses** (when using the Cloudinary media field)

## πŸ“‹ Requirements

- Strapi v5.0.0 or later
- Node.js 18+
- Cloudinary Bucket

## πŸ“¦ Installation

```bash
npm install @strapi-community/cloudinary-media-library@latest
# or
yarn add @strapi-community/cloudinary-media-library@latest
```

## πŸ” Getting Cloudinary Credentials

To retrieve your Cloudinary credentials:

- Go to https://cloudinary.com/console
- Select **Settings** > **API keys**
- Copy your cloud name and API key.

You don’t need the API secret for this integration β€” only cloud name and API key.

## βš™οΈ Setting up Configuration File

Your plugin settings should go in `config/plugins.ts`. Here’s an example:

```ts
export default {
'cloudinary-media-library': {
enabled: true,
config: {
cloudName: 'your-cloud-name',
apiKey: 'your-api-key',
encryptionKey: '32 chars encryption key',
},
},
};
```

Additionaly you can set up `cloudName` and `apiKey` properties through Settings page in the Admin panel. Please note that this configuration will overwrite `config/plugin.ts`

![Plugin Configuration](https://www.sensinum.com/img/open-source/strapi-plugin-cloudinary-media-library/cfg-plugin/1.png)

These options are passed directly to the Cloudinary Media Library widget.

**IMPORTANT** You must set the `encryptionKey` property in the config file. This key is required for Strapi to encrypt credentials in the database. If you don’t provide `encryptionKey` as a 32-character string, the media library will not work.

### Setting up `strapi::security` middlewares to avoid CSP blocking Cloudinary

When using Cloudinary's Media Library Plugin, modern browsers enforce Content Security Policy (CSP) rules. These policies prevent scripts, images, frames, and other resources from loading if they originate from domains not explicitly allowed β€” which will cause the Cloudinary widget to break.

To fix this, you need to explicitly allow Cloudinary domains in Strapi's security middleware configuration.

Edit `./config/middlewares.js`

```ts
export default [
'strapi::logger',
'strapi::errors',
{
name: 'strapi::security',
config: {
contentSecurityPolicy: {
useDefaults: true,
directives: {
'connect-src': ["'self'", 'https:'],
'img-src': [
"'self'",
'data:',
'blob:',
'https://market-assets.strapi.io',
'https://console.cloudinary.com',
'https://res.cloudinary.com',
],
'script-src': [
"'self'",
'example.com',
'https://media-library.cloudinary.com',
'https://upload-widget.cloudinary.com',
'https://console.cloudinary.com',
],
'media-src': [
"'self'",
'data:',
'blob:',
'https://console.cloudinary.com',
'https://res.cloudinary.com',
],
'frame-src': [
"'self'",
'https://media-library.cloudinary.com',
'https://upload-widget.cloudinary.com',
'https://console.cloudinary.com',
],
upgradeInsecureRequests: null,
},
},
},
},
'strapi::cors',
'strapi::poweredBy',
'strapi::query',
'strapi::body',
'strapi::session',
'strapi::favicon',
'strapi::public',
];
```

## πŸ” Managing Permissions

The **Cloudinary Media Library** plugin supports two types of role-based permissions to control access to its features:

| Permission | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `Read` | Allows the user to **view Cloudinary credentials** in the Settings page and **upload media** using the Cloudinary input field. |
| `Settings` | Grants full access to **modify** Cloudinary configuration (cloud name and API key). |

### How to manage permissions

1. Go to the **Strapi Admin Panel**.
2. Navigate to **Settings β†’ Administration Panel β†’ Roles**.
3. Select a role (e.g., `Authenticated` or `Super Admin`).
4. Select the **Plugins** section.
5. Find and expand **cloudinary-media-library**.
6. Check the permissions you want to enable:
- `β˜‘ Read`
- `β˜‘ Settings`
7. Save changes.

## πŸ‘¨β€πŸ’» Development & Testing

- Build: `yarn build`
- Test backend: `yarn test:server`
- Test frontend: `yarn test:ts:front`

## πŸ”— Links

- [Strapi website](http://strapi.io/)
- [Strapi community on Slack](http://slack.strapi.io)
- [Strapi news on Twitter](https://twitter.com/strapijs)

## πŸ’¬ Community support

- [GitHub](https://github.com/strapi-community/cloudinary-media-library) (Bug reports, contributions)

You can also used official support platform of Strapi, and search `[VirtusLab]` prefixed people (maintainers)

- [Discord](https://discord.strapi.io) (For live discussion with the Community and Strapi team)
- [Community Forum](https://forum.strapi.io) (Questions and Discussions)

## πŸ“„ License

See the [MIT License](LICENSE) file for licensing information.