v1.69

Cloudinary

This is a backend for the Cloudinary platform

About Cloudinary

Cloudinary is an image and video API platform. Trusted by 1.5 million developers and 10,000 enterprise and hyper-growth companies as a critical part of their tech stack to deliver visually engaging experiences.

Accounts & Pricing

To use this backend, you need to create a free account on Cloudinary. Start with a free plan with generous usage limits. Then, as your requirements grow, upgrade to a plan that best fits your needs. See the pricing details.

Securing Your Credentials

Please refer to the docs

Configuration

Here is an example of making a Cloudinary configuration.

First, create a cloudinary.com account and choose a plan.

You will need to log in and get the API Key and API Secret for your account from the developer section.

Now run

rclone config

Follow the interactive setup process:

  1. No remotes found, make a new one?
  2. n) New remote
  3. s) Set configuration password
  4. q) Quit config
  5. n/s/q> n
  7. Enter the name for the new remote.
  8. name> cloudinary-media-library
  10. Option Storage.
  11. Type of storage to configure.
  12. Choose a number from below, or type in your own value.
  13. [snip]
  14. XX / cloudinary.com
  15. \ (cloudinary)
  16. [snip]
  17. Storage> cloudinary
  19. Option cloud_name.
  20. You can find your cloudinary.com cloud_name in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
  21. Enter a value.
  22. cloud_name> ****************************
  24. Option api_key.
  25. You can find your cloudinary.com api key in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
  26. Enter a value.
  27. api_key> ****************************
  29. Option api_secret.
  30. You can find your cloudinary.com api secret in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
  31. This value must be a single character, one of the following: y, g.
  32. y/g> y
  33. Enter a value.
  34. api_secret> ****************************
  36. Option upload_prefix.
  37. [Upload prefix](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters) to specify alternative data center
  38. Enter a value.
  39. upload_prefix>
  41. Option upload_preset.
  42. [Upload presets](https://cloudinary.com/documentation/upload_presets) can be defined for different upload profiles
  43. Enter a value.
  44. upload_preset>
  46. Edit advanced config?
  47. y) Yes
  48. n) No (default)
  49. y/n> n
  51. Configuration complete.
  52. Options:
  53. - type: cloudinary
  54. - api_key: ****************************
  55. - api_secret: ****************************
  56. - cloud_name: ****************************
  57. - upload_prefix:
  58. - upload_preset:
  60. Keep this "cloudinary-media-library" remote?
  61. y) Yes this is OK (default)
  62. e) Edit this remote
  63. d) Delete this remote
  64. y/e/d> y

List directories in the top level of your Media Library

rclone lsd cloudinary-media-library:

Make a new directory.

rclone mkdir cloudinary-media-library:directory

List the contents of a directory.

rclone ls cloudinary-media-library:directory

Modified time and hashes

Cloudinary stores md5 and timestamps for any successful Put automatically and read-only.

Standard options

Here are the Standard options specific to cloudinary (Cloudinary).

--cloudinary-cloud-name

Cloudinary Environment Name

Properties:

  • Config: cloud_name
  • Env Var: RCLONE_CLOUDINARY_CLOUD_NAME
  • Type: string
  • Required: true

--cloudinary-api-key

Cloudinary API Key

Properties:

  • Config: api_key
  • Env Var: RCLONE_CLOUDINARY_API_KEY
  • Type: string
  • Required: true

--cloudinary-api-secret

Cloudinary API Secret

Properties:

  • Config: api_secret
  • Env Var: RCLONE_CLOUDINARY_API_SECRET
  • Type: string
  • Required: true

--cloudinary-upload-prefix

Specify the API endpoint for environments out of the US

Properties:

  • Config: upload_prefix
  • Env Var: RCLONE_CLOUDINARY_UPLOAD_PREFIX
  • Type: string
  • Required: false

--cloudinary-upload-preset

Upload Preset to select asset manipulation on upload

Properties:

  • Config: upload_preset
  • Env Var: RCLONE_CLOUDINARY_UPLOAD_PRESET
  • Type: string
  • Required: false

Advanced options

Here are the Advanced options specific to cloudinary (Cloudinary).

--cloudinary-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

  • Config: encoding
  • Env Var: RCLONE_CLOUDINARY_ENCODING
  • Type: Encoding
  • Default: Slash,LtGt,DoubleQuote,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot

--cloudinary-eventually-consistent-delay

Wait N seconds for eventual consistency of the databases that support the backend operation

Properties:

  • Config: eventually_consistent_delay
  • Env Var: RCLONE_CLOUDINARY_EVENTUALLY_CONSISTENT_DELAY
  • Type: Duration
  • Default: 0s

--cloudinary-description

Description of the remote.

Properties:

  • Config: description
  • Env Var: RCLONE_CLOUDINARY_DESCRIPTION
  • Type: string
  • Required: false