This a Firebase Storage adapter for Ghost CMS. Images uploaded via Ghost CMS will be save to Firebase Storage.
At the root of you ghost blog, install this adapter using either npm
or
yarn
.
npm i ghost-firebase-storage-adapter
yarn add ghost-firebase-storage-adapter
After installation, a scripts runs that automatically creates a storage adapter
in the content/adapters/storage
directory, named firebase.js
with the
following content:
'use strict'
module.exports = require('ghost-firebase-storage-adapter');
NB: if the
firebase.js
was not created, create it in thecontent/adapters/storage
directory and add the above content.
Before we can proceed, make sure you have the bucket-name, without any prefix (
gs://
) or suffix (.appspot.com
) and your Firebase Service Account Private Key, ajson
file.
storage
block to your config.${GHOST_ENVIRONMENT}.json
as shown below:"storage": {
"active": "firebase",
"firebase": {
// configurations for the storage adapter
"serviceAccount": "./path/to/service/account.json",
"bucketName": "bucket-name",
"basePath": "base path for saving uploads",
"uploadOptions": {
"gzip": true,
"metadata": {
"cacheControl": "public, max-age=31536000"
}
}
}
}
For more information, see the example config here.
serviceAccount
(required
) - Path to your firebase service account
credential file, you can provide a relative or absolute path to the credential file.
bucketName
(required
) - The bucket to save ghost uploads to
basePath
- the base directory to upload file to inside your Firebase storage
bucket.
uploadOptions
- Configuration options for bucket file upload as indicated
here.
All fields can be appended except the destination:
Example
{
"metadata": {
"cacheControl": "public, max-age=30000",
},
"public": "true",
"gzip": true
}
domain
- Custom domain name to append to the file destination. Use this
option if you are using a Firebase Cloud Functions to serve images.
To verify everything is configured correctly, stop your ghost server and run it again.
ghost stop
ghost run
Fix any errors that come up and try again. After that, try and uploading a file and it should be accessible on your Firebase storage bucket.
Contributions of any kind - bug reports, pull request, feature suggestions are welcome.