@nexrender/provider-gs
v1.50.8
Published
Allows nexrender to interact with a Google Cloud Storage (GCS) bucket.
Downloads
3,083
Readme
Provider: GCS
Allows nexrender to interact with a Google Cloud Storage (GCS) bucket.
Refer to @google-cloud/storage for information regarding general abilities and usage.
Installation
npm i @nexrender/provider-gs -g
You most likely need to authenticate to interact with a GCS bucket. This provider uses Application Default Credentials. Refer to the Google Cloud Documentation for more information on authentication.
Usage (download)
To download assets from a GCS bucket, you can use the gs://
prefix in the value of the src
attribute.
{
"assets": [
{
"src": "gs://mybucket/background.jpg",
"type": "image",
"layerName": "background.png"
},
{
"src": "gs://myotherbucket/audio.mp3",
"type": "audio",
"layerName": "theme.mp3"
}
]
}
Uri follows this scheme:
gs://[BUCKET]/[ITEM]
Usage (upload)
Upload via GCS can be done using @nexrender/action-upload
Basic params info:
bucket
required argument, the GCS bucketitem
required argument, the item IDcontentType
optional argument, the content-type of the upload, which will be set as metadata oncacheControl
optional argument, the cache-control of the upload, which will be set as metadata on the bucket itemresumable
boolean, optional argument, disables resumable (true by default) google storage documentation
Example:
{
"actions": {
"postrender": [
{
"module": "@nexrender/action-upload",
"input": "result.mp4",
"provider": "gs",
"params": {
"bucket": "name-of-your-bucket",
"item": "folder/output.mp4",
"contentType": "video/mp4",
"cacheControl": "public, max-age=3600",
"resumable": false
}
}
]
}
}