cloudinary: add cloudinary backend - fixes #7989
This commit is contained in:
yuval-cloudinary
Nick Craig-Wood
parent
5151a663f0
commit
7e4b8e33f5
13 changed files with 1036 additions and 1 deletions
|
|
@ -116,6 +116,7 @@ WebDAV or S3, that work out of the box.)
|
|||
{{< provider name="Arvan Cloud Object Storage (AOS)" home="https://www.arvancloud.ir/en/products/cloud-storage" config="/s3/#arvan-cloud-object-storage-aos" >}}
|
||||
{{< provider name="Citrix ShareFile" home="http://sharefile.com/" config="/sharefile/" >}}
|
||||
{{< provider name="Cloudflare R2" home="https://blog.cloudflare.com/r2-open-beta/" config="/s3/#cloudflare-r2" >}}
|
||||
{{< provider name="Cloudinary" home="https://cloudinary.com/" config="/cloudinary/" >}}
|
||||
{{< provider name="DigitalOcean Spaces" home="https://www.digitalocean.com/products/object-storage/" config="/s3/#digitalocean-spaces" >}}
|
||||
{{< provider name="Digi Storage" home="https://storage.rcs-rds.ro/" config="/koofr/#digi-storage" >}}
|
||||
{{< provider name="Dreamhost" home="https://www.dreamhost.com/cloud/storage/" config="/s3/#dreamhost" >}}
|
||||
|
|
|
|||
222
docs/content/cloudinary.md
Normal file
222
docs/content/cloudinary.md
Normal file
|
|
@ -0,0 +1,222 @@
|
|||
---
|
||||
title: "Cloudinary"
|
||||
description: "Rclone docs for Cloudinary backend"
|
||||
versionIntroduced: "v1.69"
|
||||
|
||||
---
|
||||
# {{< icon "fa fa-cloud" >}} Cloudinary
|
||||
|
||||
This is a backend for the [Cloudinary](https://cloudinary.com/) platform
|
||||
|
||||
## About Cloudinary
|
||||
|
||||
[Cloudinary](https://cloudinary.com/) 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](https://cloudinary.com/users/register_free) 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](https://cloudinary.com/pricing).
|
||||
|
||||
## Securing Your Credentials
|
||||
|
||||
Please refer to the [docs](/docs/#configuration-encryption-cheatsheet)
|
||||
|
||||
## Configuration
|
||||
|
||||
Here is an example of making a Cloudinary configuration.
|
||||
|
||||
First, create a [cloudinary.com](https://cloudinary.com/users/register_free) 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:
|
||||
|
||||
```text
|
||||
No remotes found, make a new one?
|
||||
n) New remote
|
||||
s) Set configuration password
|
||||
q) Quit config
|
||||
n/s/q> n
|
||||
|
||||
Enter the name for the new remote.
|
||||
name> cloudinary-media-library
|
||||
|
||||
Option Storage.
|
||||
Type of storage to configure.
|
||||
Choose a number from below, or type in your own value.
|
||||
[snip]
|
||||
XX / cloudinary.com
|
||||
\ (cloudinary)
|
||||
[snip]
|
||||
Storage> cloudinary
|
||||
|
||||
Option cloud_name.
|
||||
You can find your cloudinary.com cloud_name in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
|
||||
Enter a value.
|
||||
cloud_name> ****************************
|
||||
|
||||
Option api_key.
|
||||
You can find your cloudinary.com api key in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
|
||||
Enter a value.
|
||||
api_key> ****************************
|
||||
|
||||
Option api_secret.
|
||||
You can find your cloudinary.com api secret in your [dashboard](https://console.cloudinary.com/pm/developer-dashboard)
|
||||
This value must be a single character, one of the following: y, g.
|
||||
y/g> y
|
||||
Enter a value.
|
||||
api_secret> ****************************
|
||||
|
||||
Option upload_prefix.
|
||||
[Upload prefix](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters) to specify alternative data center
|
||||
Enter a value.
|
||||
upload_prefix>
|
||||
|
||||
Option upload_preset.
|
||||
[Upload presets](https://cloudinary.com/documentation/upload_presets) can be defined for different upload profiles
|
||||
Enter a value.
|
||||
upload_preset>
|
||||
|
||||
Edit advanced config?
|
||||
y) Yes
|
||||
n) No (default)
|
||||
y/n> n
|
||||
|
||||
Configuration complete.
|
||||
Options:
|
||||
- type: cloudinary
|
||||
- api_key: ****************************
|
||||
- api_secret: ****************************
|
||||
- cloud_name: ****************************
|
||||
- upload_prefix:
|
||||
- upload_preset:
|
||||
|
||||
Keep this "cloudinary-media-library" remote?
|
||||
y) Yes this is OK (default)
|
||||
e) Edit this remote
|
||||
d) Delete this remote
|
||||
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.
|
||||
|
||||
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/cloudinary/cloudinary.go then run make backenddocs" >}}
|
||||
### 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
|
||||
|
||||
**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
|
||||
|
||||
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](/overview/#encoding) 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
|
||||
|
||||
{{< rem autogenerated options stop >}}
|
||||
|
|
@ -36,6 +36,7 @@ See the following for detailed instructions for
|
|||
* [Chunker](/chunker/) - transparently splits large files for other remotes
|
||||
* [Citrix ShareFile](/sharefile/)
|
||||
* [Compress](/compress/)
|
||||
* [Cloudinary](/cloudinary/)
|
||||
* [Combine](/combine/)
|
||||
* [Crypt](/crypt/) - to encrypt other remotes
|
||||
* [DigitalOcean Spaces](/s3/#digitalocean-spaces)
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@ Here is an overview of the major features of each cloud storage system.
|
|||
| Backblaze B2 | SHA1 | R/W | No | No | R/W | - |
|
||||
| Box | SHA1 | R/W | Yes | No | - | - |
|
||||
| Citrix ShareFile | MD5 | R/W | Yes | No | - | - |
|
||||
| Cloudinary | MD5 | R | No | Yes | - | - |
|
||||
| Dropbox | DBHASH ¹ | R | Yes | No | - | - |
|
||||
| Enterprise File Fabric | - | R/W | Yes | No | R/W | - |
|
||||
| Files.com | MD5, CRC32 | DR/W | Yes | No | R | - |
|
||||
|
|
@ -502,6 +503,7 @@ upon backend-specific capabilities.
|
|||
| Box | Yes | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | Yes |
|
||||
| Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | No | No | No | No | Yes |
|
||||
| Dropbox | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | Yes | Yes |
|
||||
| Cloudinary | No | No | No | No | No | No | Yes | No | No | No | No |
|
||||
| Enterprise File Fabric | Yes | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes |
|
||||
| Files.com | Yes | Yes | Yes | Yes | No | No | Yes | No | Yes | No | Yes |
|
||||
| FTP | No | No | Yes | Yes | No | No | Yes | No | No | No | Yes |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue