Gathering detailed insights and metrics for @strapi-community/strapi-provider-upload-google-cloud-storage
Gathering detailed insights and metrics for @strapi-community/strapi-provider-upload-google-cloud-storage
Google Cloud Storage Upload Provider for Strapi
Installations
npm install @strapi-community/strapi-provider-upload-google-cloud-storageDeveloper
strapi-community
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
^16 || ^18
Typescript Support
No
Node Version
16.20.0
NPM Version
8.19.4
Statistics
211 Stars
112 Commits
94 Forks
5 Watching
5 Branches
31 Contributors
Updated on 27 Sept 2024
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
528,949
Last day
-5%
698
Compared to previous day
Last week
-0.1%
3,805
Compared to previous week
Last month
1.5%
16,515
Compared to previous month
Last year
-2.5%
216,777
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
strapi-provider-upload-google-cloud-storage
Non-Official Google Cloud Storage Provider for Strapi Upload
Installation
Install the package from your app root directory
with npm
npm install @strapi-community/strapi-provider-upload-google-cloud-storage --save
or yarn
yarn add @strapi-community/strapi-provider-upload-google-cloud-storage
Create your Bucket on Google Cloud Storage
The bucket should be created with fine grained access control, as the plugin will configure uploaded files with public read access.
How to create a bucket ?
Where my bucket can be located ?
Setting up Google authentication
If you are deploying to a Google Cloud Platform product that supports Application Default Credentials (such as App Engine, Cloud Run, and Cloud Functions etc.), then you can skip this step.
If you are deploying outside GCP, then follow these steps to set up authentication:
- In the GCP Console, go to the Create service account key page.
- From the Service account list, select New service account.
- In the Service account name field, enter a name.
- From the Role list, select Cloud Storage > Storage Admin.
- Select
JSONfor Key Type - Click Create. A JSON file that contains your key downloads to your computer.
- Copy the full content of the downloaded JSON file
- Open the Strapi configuration file
- Paste it into the "Service Account JSON" field (as
stringorJSON, be careful with indentation)
Setting up the configuration file
You will find below many examples of configurations, for each example :
- If you are deploying outside GCP, then follow the steps above Setting up Google authentication
- Set the
#bucketName#field and replaceBucket-nameby yours previously create - Default
baseUrlis working, but you can replace it by yours (if you use a custom baseUrl) - Save the configuration file
- Enjoy !
Example with application default credentials (minimal setup)
This works only for deployment to GCP products such as App Engine, Cloud Run, and Cloud Functions etc.
Edit ./config/plugins.js
1module.exports = { 2 upload: { 3 config: { 4 provider: '@strapi-community/strapi-provider-upload-google-cloud-storage', 5 providerOptions: { 6 bucketName: '#bucketName#', 7 publicFiles: false, 8 uniform: false, 9 basePath: '', 10 }, 11 }, 12 }, 13 //... 14}
If you set publicFiles to false, the assets will be signed on the Content Manager (not the Content API). Consequently, they will only be visible to users who are authenticated.
You can set the expiry time of the signed URL by setting the expires option in the providerOptions object. See more in expires.
Example with credentials for outside GCP account
Edit ./config/plugins.js
1module.exports = { 2 upload: { 3 config: { 4 provider: '@strapi-community/strapi-provider-upload-google-cloud-storage', 5 providerOptions: { 6 bucketName: '#bucketName#', 7 publicFiles: true, 8 uniform: false, 9 serviceAccount: {}, // replace `{}` with your serviceAccount JSON object 10 baseUrl: 'https://storage.googleapis.com/{bucket-name}', 11 basePath: '', 12 }, 13 }, 14 }, 15 //... 16}
If you have different upload provider by environment, you can override plugins.js file by environment :
config/env/development/plugins.jsconfig/env/production/plugins.js
This file, under config/env/{env}/ will be overriding default configuration present in main folder config.
Example with environment variable
1module.exports = ({ env }) => ({ 2 upload: { 3 config: { 4 provider: '@strapi-community/strapi-provider-upload-google-cloud-storage', 5 providerOptions: { 6 serviceAccount: env.json('GCS_SERVICE_ACCOUNT'), 7 bucketName: env('GCS_BUCKET_NAME'), 8 basePath: env('GCS_BASE_PATH'), 9 baseUrl: env('GCS_BASE_URL'), 10 publicFiles: env('GCS_PUBLIC_FILES'), 11 uniform: env('GCS_UNIFORM'), 12 }, 13 }, 14 }, 15 //... 16});
Environment variable can be changed has your way.
Setting up strapi::security middlewares to avoid CSP blocked url
Edit ./config/middlewares.js
- In the field
img-srcandmedia-srcadd your own CDN url, by default it'sstorage.googleapis.combut you need to add your own CDN url
1module.exports = [ 2 'strapi::errors', 3 { 4 name: 'strapi::security', 5 config: { 6 contentSecurityPolicy: { 7 useDefaults: true, 8 directives: { 9 'connect-src': ["'self'", 'https:'], 10 'img-src': ["'self'", 'data:', 'blob:', 'storage.googleapis.com'], 11 'media-src': ["'self'", 'data:', 'blob:', 'storage.googleapis.com'], 12 upgradeInsecureRequests: null, 13 }, 14 }, 15 }, 16 }, 17 'strapi::cors', 18 'strapi::poweredBy', 19 'strapi::logger', 20 'strapi::query', 21 'strapi::body', 22 'strapi::favicon', 23 'strapi::public', 24];
How to configure variable ?
serviceAccount :
JSON data provide by Google Account (explained before). If you are deploying to a GCP product that supports Application Default credentials, you can leave this omitted, and authentication will work automatically.
Can be set as a String, JSON Object, or omitted.
bucketName :
The name of the bucket on Google Cloud Storage.
- Required
You can find more information on Google Cloud documentation.
baseUrl :
Define your base Url, first is default value :
- https://storage.googleapis.com/{bucket-name}
- https://{bucket-name}
- http://{bucket-name}
basePath :
Define base path to save each media document.
- Optional
publicFiles:
Boolean to define a public attribute to file when upload file to storage.
- Default value :
true - Optional
uniform:
Boolean to define uniform access, when uniform bucket-level access is enabled.
- Default value :
false - Optional
skipCheckBucket:
Boolean to define skipCheckBucket, when skipCheckBucket is enabled, we skip to check if the bucket exist. It's useful for private bucket.
- Default value :
false - Optional
cacheMaxAge:
Number to set the cache-control header for uploaded files.
- Default value :
3600 - Optional
gzip:
Value to define if files are uploaded and stored with gzip compression.
- Possible values:
true,false,auto - Default value :
auto - Optional
expires:
Value to define expiration time for signed URLS. Files are signed when publicFiles is set to false.
- Possible values:
Date,number,string - Default value :
900000(15 minutes) - Max value :
604800000(7 days) - Optional
metadata:
Function that is executed to compute the metadata for a file when it is uploaded.
When no function is provided, the following metadata is used:
1{ 2 contentDisposition: `inline; filename="${file.name}"`, 3 cacheControl: `public, max-age=${config.cacheMaxAge || 3600}`, 4}
- Default value:
undefined - Optional
Example:
1 metadata: (file) => ({ 2 cacheControl: `public, max-age=${60 * 60 * 24 * 7}`, // One week 3 contentLanguage: 'en-US', 4 contentDisposition: `attachment; filename="${file.name}"`, 5 }),
The available properties can be found in the Cloud Storage JSON API documentation.
generateUploadFileName:
Function that is executed to generate the name of the uploaded file. This method can give more control over the file name and can for example be used to include a custom hashing function or dynamic path.
When no function is provided, the default algorithm is used.
- Default value:
undefined - Optional
Example:
1 generateUploadFileName: async (file) => { 2 const hash = await ...; // Some hashing function, for example MD-5 3 const extension = file.ext.toLowerCase().substring(1); 4 return `${extension}/${slugify(path.parse(file.name).name)}-${hash}.${extension}`; 5 },
FAQ
Common errors
Uniform access
Error uploading file to Google Cloud Storage: Cannot insert legacy ACL for an object when uniform bucket-level access is enabled
When this error occurs, you need to set uniform variable to true.
Service Account JSON
Error: Error parsing data "Service Account JSON", please be sure to copy/paste the full JSON file
When this error occurs, it's probably because you have missed something with the service account json configuration.
Follow this step :
- Open your
ServiceAccountjson file - Copy the full content of the file
- Paste it under the variable
ServiceAccountinplugins.jsconfig file in JSON
Migration
Due to release of Strapi v4, you need to migrate your databases files informations. Follow our migration guide.
Links
Community support
- GitHub (Bug reports, contributions)
You can also used official support platform of Strapi, and search @Lith (maintainer)
- Discord (For live discussion with the Community and Strapi team)
- Community Forum (Questions and Discussions)
License
See the MIT License file for licensing information.
No vulnerabilities found.
No security vulnerabilities found.