Cloudinary Node SDK

The Photo Album sample is a simple application for uploading images and displaying them in a list. It utilizes the jugglingdb ORM for data management.

To run this sample:

1. Configure your Cloudinary credentials by copying the environment variable configuration parameters from your Cloudinary Management Console into a .env file in the project directory, or by exporting the CLOUDINARY_URL variable (e.g., export CLOUDINARY_URL=xxx).
2. Install dependencies using npm install.
3. Start the server using npm start. For a development mode server with automatic reloading, use npm run dev.
4. Access the application in your browser at http://localhost:9000.

# Configuration
export CLOUDINARY_URL=cloudinary://api_key:api_secret@cloud_name

# Installation
npm install

# Run in production mode
npm start

# OR run in development mode (auto-reload)
npm run dev

To use a custom storage mechanism for Cloudinary caching, you must extend the CacheAdapter class and implement its core methods. The Cache singleton will then use your implementation to store and retrieve values based on asset identifiers and transformations.

Your adapter must implement the following methods:

• get(publicId, type, resourceType, transformation, format): Retrieves a value from the cache.
• set(publicId, type, resourceType, transformation, format, value): Stores a value in the cache.
• flushAll(): Deletes all values in the cache.

Note that the Cache singleton automatically handles the generation of the transformation string from your options object before calling these methods.

const { CacheAdapter } = require('cloudinary').Cache;

class MyCustomAdapter extends CacheAdapter {
  get(publicId, type, resourceType, transformation, format) {
    // Your logic to retrieve from Redis, Memcached, etc.
  }

  set(publicId, type, resourceType, transformation, format, value) {
    // Your logic to store in Redis, Memcached, etc.
  }

  flushAll() {
    // Your logic to clear the cache
  }
}

// Register the adapter
const Cache = require('cloudinary').Cache;
Cache.setAdapter(new MyCustomAdapter());

The Cloudinary Node SDK automatically loads configuration from specific environment variables. This is useful for setting up credentials without hardcoding them in your application logic.

Supported Environment Variables

• CLOUDINARY_URL: A connection string used to set cloud_name, api_key, api_secret, and other parameters. It must use the cloudinary:// protocol.
  • Format: cloudinary://<api_key>:<api_secret>@<cloud_name>?<query_params>
  • Query Parameters: You can use bracket notation in the query string to set nested configuration keys (e.g., ?foo[bar]=value sets config.foo.bar).
• CLOUDINARY_ACCOUNT_URL: A connection string for account-level provisioning. It must use the account:// protocol.
  • Format: account://<provisioning_api_key>:<provisioning_api_secret>@<account_id>
• CLOUDINARY_API_PROXY: Sets the api_proxy configuration key.

Protocol Requirements

• CLOUDINARY_URL must start with cloudinary://.
• CLOUDINARY_ACCOUNT_URL must start with account://.

You can configure the SDK by calling the main Cloudinary module function. The behavior of this function changes based on the arguments provided:

1. Initialize/Reset: Calling the function with true as the first argument resets the existing configuration.
2. Set a single value: Pass a key (string) and a value. cloudinary(key, value).
3. Set multiple values: Pass an object containing configuration keys. cloudinary({ key: value }).
4. Get a value: Pass a string key to retrieve a specific configuration value. cloudinary(key).
5. Get full config: Calling the function without arguments returns the entire configuration object.

Note: If environment variables are present, they are loaded during the first call to the configuration function.

const cloudinary = require('cloudinary');

// Set multiple configuration options
cloudinary({
  cloud_name: 'my_cloud_name',
  api_key: '123456789',
  api_secret: 'my_secret'
});

// Set a single option
cloudinary('api_proxy', 'http://my-proxy.com');

// Retrieve a specific option
const apiKey = cloudinary('api_key');

// Retrieve the entire configuration object
const fullConfig = cloudinary();