@aaron_lejeune/strapi-provider-upload-uploadcare
v1.2.9
Published
Upload provider for Strapi using UploadCare
Downloads
324
Maintainers
Readme
@aaron_lejeune/strapi-provider-upload-uploadcare
Installation
# using yarn
yarn add @aaron_lejeune/strapi-provider-upload-uploadcare
# using npm
npm install @aaron_lejeune/strapi-provider-upload-uploadcare --save
Configuration
provider
defines the name of the providerproviderOptions
is passed down during the construction of the provider.actionOptions
is passed directly to each method respectively allowing for custom options. You can find the complete list of upload/ uploadStream options and delete optionsvideo_size
You can change your video canvas size, quality, format, and length by applying video transform operations. The type must bearray
. More information of all operation can be found here. The default values are ['x720', 'x1024']
See the documentation about using a provider for information on installing and using a provider. To understand how environment variables are used in Strapi, please refer to the documentation about environment variables.
Your configuration is passed down to the uploadcare configuration. (e.g: UploadClient({})
). You can see the complete list of options here
See the using a provider documentation for information on installing and using a provider. And see the environment variables for setting and using environment variables in your configs.
Provider Configuration
./config/plugins.js
module.exports = ({ env }) => ({
// ...
upload: {
config: {
provider: '@aaron_lejeune/strapi-provider-upload-uploadcare',
providerOptions: {
public_key: env('UPLOADCARE_PUBLIC_KEY'),
secret_key: env('UPLOADCARE_SECRET_KEY'),
base_cdn: env('UPLOADCARE_BASE_CDN'),
video_size: ['x720', 'x1024']
},
},
},
// ...
});
https://github.com/uploadcare/uploadcare-upload-client#settings
public_key: string
The main use of a public_key
is to identify a target project for your uploads. It is required when using Upload API.
base_cdn: string
Defines your schema and CDN domain. Can be changed to one of the predefined values (https://ucarecdn.com/) or your custom CNAME.
Defaults to https://ucarecdn.com/
.
BONUS: Turn off Strapi's "Responsive friendly upload"
Because Uploadcare is already handling responsive uploads, file optimisation, ... we dont need Strapi to be uploading the file in different sizes. This will just fill the UploadCare CDN with images/versions we're never going to use.
To turn off this feature, go to your Strapi admin panel -> Settings -> Media Library:
- Responsive friendly upload:
False
- Size optimization:
False
- Auto orientation:
False
Security Middleware Configuration
Due to the default settings in the Strapi Security Middleware you will need to modify the contentSecurityPolicy
settings to properly see thumbnail previews in the Media Library. You should replace strapi::security
string with the object bellow instead as explained in the middleware configuration documentation.
./config/middlewares.js
module.exports = [
// ...
{
name: 'strapi::security',
config: {
contentSecurityPolicy: {
useDefaults: true,
directives: {
'connect-src': ["'self'", 'https:'],
'img-src': ["
'self'",
'data:',
'blob:',
'market-assets.strapi.io',
'ucarecdn.com', //uploadcare
'-- your custom base_cdn', //custom base_cdn
// ...
],
'media-src': ["
'self'",
'data:',
'blob:',
'market-assets.strapi.io',
'ucarecdn.com', //uploadcare
'-- your custom base_cdn', //custom base_cdn
// ...
],
upgradeInsecureRequests: null,
},
},
},
},
// ...
];