github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/imagekit.md (about) 1 --- 2 title: "ImageKit" 3 description: "Rclone docs for ImageKit backend." 4 versionIntroduced: "v1.63" 5 6 --- 7 # {{< icon "fa fa-cloud" >}} ImageKit 8 This is a backend for the [ImageKit.io](https://imagekit.io/) storage service. 9 10 #### About ImageKit 11 [ImageKit.io](https://imagekit.io/) provides real-time image and video optimizations, transformations, and CDN delivery. Over 1,000 businesses and 70,000 developers trust ImageKit with their images and videos on the web. 12 13 14 #### Accounts & Pricing 15 16 To use this backend, you need to [create an account](https://imagekit.io/registration/) on ImageKit. 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://imagekit.io/plans). 17 18 ## Configuration 19 20 Here is an example of making an imagekit configuration. 21 22 Firstly create a [ImageKit.io](https://imagekit.io/) account and choose a plan. 23 24 You will need to log in and get the `publicKey` and `privateKey` for your account from the developer section. 25 26 Now run 27 ``` 28 rclone config 29 ``` 30 31 This will guide you through an interactive setup process: 32 33 ``` 34 No remotes found, make a new one? 35 n) New remote 36 s) Set configuration password 37 q) Quit config 38 n/s/q> n 39 40 Enter the name for the new remote. 41 name> imagekit-media-library 42 43 Option Storage. 44 Type of storage to configure. 45 Choose a number from below, or type in your own value. 46 [snip] 47 XX / ImageKit.io 48 \ (imagekit) 49 [snip] 50 Storage> imagekit 51 52 Option endpoint. 53 You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 54 Enter a value. 55 endpoint> https://ik.imagekit.io/imagekit_id 56 57 Option public_key. 58 You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 59 Enter a value. 60 public_key> public_**************************** 61 62 Option private_key. 63 You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 64 Enter a value. 65 private_key> private_**************************** 66 67 Edit advanced config? 68 y) Yes 69 n) No (default) 70 y/n> n 71 72 Configuration complete. 73 Options: 74 - type: imagekit 75 - endpoint: https://ik.imagekit.io/imagekit_id 76 - public_key: public_**************************** 77 - private_key: private_**************************** 78 79 Keep this "imagekit-media-library" remote? 80 y) Yes this is OK (default) 81 e) Edit this remote 82 d) Delete this remote 83 y/e/d> y 84 ``` 85 List directories in the top level of your Media Library 86 ``` 87 rclone lsd imagekit-media-library: 88 ``` 89 Make a new directory. 90 ``` 91 rclone mkdir imagekit-media-library:directory 92 ``` 93 List the contents of a directory. 94 ``` 95 rclone ls imagekit-media-library:directory 96 ``` 97 98 ### Modified time and hashes 99 100 ImageKit does not support modification times or hashes yet. 101 102 ### Checksums 103 104 No checksums are supported. 105 106 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/imagekit/imagekit.go then run make backenddocs" >}} 107 ### Standard options 108 109 Here are the Standard options specific to imagekit (ImageKit.io). 110 111 #### --imagekit-endpoint 112 113 You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 114 115 Properties: 116 117 - Config: endpoint 118 - Env Var: RCLONE_IMAGEKIT_ENDPOINT 119 - Type: string 120 - Required: true 121 122 #### --imagekit-public-key 123 124 You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 125 126 Properties: 127 128 - Config: public_key 129 - Env Var: RCLONE_IMAGEKIT_PUBLIC_KEY 130 - Type: string 131 - Required: true 132 133 #### --imagekit-private-key 134 135 You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 136 137 Properties: 138 139 - Config: private_key 140 - Env Var: RCLONE_IMAGEKIT_PRIVATE_KEY 141 - Type: string 142 - Required: true 143 144 ### Advanced options 145 146 Here are the Advanced options specific to imagekit (ImageKit.io). 147 148 #### --imagekit-only-signed 149 150 If you have configured `Restrict unsigned image URLs` in your dashboard settings, set this to true. 151 152 Properties: 153 154 - Config: only_signed 155 - Env Var: RCLONE_IMAGEKIT_ONLY_SIGNED 156 - Type: bool 157 - Default: false 158 159 #### --imagekit-versions 160 161 Include old versions in directory listings. 162 163 Properties: 164 165 - Config: versions 166 - Env Var: RCLONE_IMAGEKIT_VERSIONS 167 - Type: bool 168 - Default: false 169 170 #### --imagekit-upload-tags 171 172 Tags to add to the uploaded files, e.g. "tag1,tag2". 173 174 Properties: 175 176 - Config: upload_tags 177 - Env Var: RCLONE_IMAGEKIT_UPLOAD_TAGS 178 - Type: string 179 - Required: false 180 181 #### --imagekit-encoding 182 183 The encoding for the backend. 184 185 See the [encoding section in the overview](/overview/#encoding) for more info. 186 187 Properties: 188 189 - Config: encoding 190 - Env Var: RCLONE_IMAGEKIT_ENCODING 191 - Type: Encoding 192 - Default: Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket 193 194 #### --imagekit-description 195 196 Description of the remote 197 198 Properties: 199 200 - Config: description 201 - Env Var: RCLONE_IMAGEKIT_DESCRIPTION 202 - Type: string 203 - Required: false 204 205 ### Metadata 206 207 Any metadata supported by the underlying remote is read and written. 208 209 Here are the possible system metadata items for the imagekit backend. 210 211 | Name | Help | Type | Example | Read Only | 212 |------|------|------|---------|-----------| 213 | aws-tags | AI generated tags by AWS Rekognition associated with the image | string | tag1,tag2 | **Y** | 214 | btime | Time of file birth (creation) read from Last-Modified header | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | **Y** | 215 | custom-coordinates | Custom coordinates of the file | string | 0,0,100,100 | **Y** | 216 | file-type | Type of the file | string | image | **Y** | 217 | google-tags | AI generated tags by Google Cloud Vision associated with the image | string | tag1,tag2 | **Y** | 218 | has-alpha | Whether the image has alpha channel or not | bool | | **Y** | 219 | height | Height of the image or video in pixels | int | | **Y** | 220 | is-private-file | Whether the file is private or not | bool | | **Y** | 221 | size | Size of the object in bytes | int64 | | **Y** | 222 | tags | Tags associated with the file | string | tag1,tag2 | **Y** | 223 | width | Width of the image or video in pixels | int | | **Y** | 224 225 See the [metadata](/docs/#metadata) docs for more info. 226 227 {{< rem autogenerated options stop >}}