Cloudinary DAM Connector

Edition

Incubator (services)

Issues

Git

Git

Latest

1.1.10

Compatible with Magnolia 6.2, 6.1.

The Cloudinary DAM Connector module 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.

This module is at the INCUBATOR level.

Installing with Maven

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

<dependency>
  <groupId>info.magnolia.external.dam</groupId>
  <artifactId>magnolia-external-dam-cloudinary</artifactId>
  <version>1.1.10</version>
</dependency>

Usage

This sections details how to use the module.

Prerequisites

You must have a Cloudinary account.

Configuration

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

Parameter Description

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 the screenshot below. You can override them in the config.yaml file as so.

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.
apiKey: /cloudinary-credentials/apiKey
apiSecret: /cloudinary-credentials/apiSecret
cloudName: cloudName
cloudinary credentials

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.

cloudinary provider

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

From 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 endpoint

Cloudinary app

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

cloudinary app

Theming

This module comes with a component template.

cloudinary theming

Changelog

Version Notes

1.1.10

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.1

1.1

Magnolia 6.2 compatibility.

1.0

Initial release of the module.

Feedback