Page tree
Skip to end of metadata
Go to start of metadata

Cloudinary DAM Connector provides a connector to  Cloudinary  to use assets form this service. It provides an app to browse and add/remove images, and a dialog to use this images/videos into your website.

Installation

Maven is the easiest way to install the module. Add the following dependency to your bundle:

Magnolia 6.2

<dependency>
  <groupId>info.magnolia.external.dam</groupId>
  <artifactId>magnolia-external-dam-cloudinary</artifactId>
  <version>{cloudinaryVersion}</version>
</dependency>

Versions

1.1.8Magnolia 6.2
1.0Magnolia 6.1

Usage

Cloudinary Account

You will need an account to connect to Cloudinary.

Configuration

Once the Cloudinary app module is installed there is some import basic configuration. We need to configure credentials for magnolia-dam-cloudinary-app. 

maxResults

optional

  • From version 1.1.4

Defines the number of resources displayed per folder, default is 50, max value is 500.

apiKey

mandatory

Credentials to connect to Cloudinary, they can be defined in the configuration or in the Passwords app.

apiSecret

mandatory

Credentials to connect to Cloudinary, they can be defined in the configuration or in the Passwords app.

cloudName

mandatory

Credentials to connect to Cloudinary, they can be defined in the configuration or in the Passwords app.


Credentials

Credentials can be stored on the Passwords app see below screenshot:


They are configured in config.yaml and can be overwritten on the module configuration:


NOTE: By default editors will have access to Cloudinary images allow to this account, they will be able to create/edit/delete, add roles to prevent those actions if needed or restrict the actions by user groups/roles.

Provider

Cloudinary provider is installed automatically from the first time it's installed. If you don't see this, it may not be installed properly, or it may be deleted by accidentally, you can recreate it similar to this structure.

Renderer

This implementation provides its own renderer:

info.magnolia.external.dam.cloudinary.renderer.CloudinaryAssetRenderer


This renderer will get the renditions from Cloudinary directly, if the rendition is just a number, it will append 'w_' by default for compatibility with the demo project, other renditions can be get like this:


damfn.getRendition(asset, "w_400,h_400,c_crop,g_face,r_max/w_200")


Endpoint

On installation of version 1.1.2/* there is new configuration that adds an endpoint and a rest role added to the anonymous user for Cloudinary access.

The endpoint will receive Cloudinary notifications to refresh the cache when working directly with Cloudinary server, to configure the notification_url, log into Cloudinary Management Console and in Settings/Upload there is the notification_url setting, it should be the domain name and the endpoint path like the following:

http://yourdomain.com/.rest/cloudinary/v1/resetCaches


Cloudinary app

The Cloudinary app is now part of the default assets app. 

Theming

This module comes with a component template.

Warnings

  • This module is at INCUBATOR level.

Changelog