A fully featured and deeply tested Cloudinary Ghost storage adapter
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
plugins
tests
.codeclimate.yml
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.travis.yml
README.md
configuration.sample.json
errors.js
index.js
package-lock.json
package.json

README.md

Ghost Storage Cloudinary

npm version Build Status Maintainability Test Coverage Greenkeeper badge

A fully featured and deeply tested Cloudinary Ghost storage adapter.

Features

  • Ghost version >=1
  • Latest Cloudinary NodeJS SDK
  • Image upload, existence check & deletion
  • Ability to upload in dated sub-directories (alike Ghost default Local storage adapter YYYY/MM)
  • Ability to upload images into a directory
  • Ability to tag images
  • Cool plugins!
  • Compatible with mmornati/ghost-cloudinary-store configuration

Installation

Install from Git

  • Go into Ghost root directory
  • Navigate to the /core/server/adapters/storage directory
  • Download the adpater:
$ git clone git@github.com:eexit/ghost-storage-cloudinary.git
  • Install the dependencies:
$ cd ghost-storage-cloudinary
$ npm install --production
  • Done, go configure

Install from NPM

  • Go into Ghost root directory
  • Download the adpater:
$ npm install --production --no-save ghost-storage-cloudinary
$ mv node_modules/ghost-storage-cloudinary core/server/adapters/storage
  • Done, go configure

Install on Docker

Here's an example of using this adapter with a containerized Ghost:

FROM ghost:1.21-alpine
WORKDIR $GHOST_INSTALL/current
RUN npm install --production --loglevel=error --no-save ghost-storage-cloudinary
RUN mv node_modules/ghost-storage-cloudinary core/server/adapters/storage
WORKDIR $GHOST_INSTALL
RUN set -ex; \
    su-exec node ghost config storage.active ghost-storage-cloudinary; \
    su-exec node ghost config storage.ghost-storage-cloudinary.upload.use_filename true; \
    su-exec node ghost config storage.ghost-storage-cloudinary.upload.unique_filename false; \
    su-exec node ghost config storage.ghost-storage-cloudinary.upload.overwrite false; \
    su-exec node ghost config storage.ghost-storage-cloudinary.fetch.quality auto; \
    su-exec node ghost config storage.ghost-storage-cloudinary.fetch.cdn_subdomain true;

Here, we use the Ghost CLI to set some pre-defined values.

Configuration

Check out configuration.sample.json for a complete example.

  • The optional useDatedFolder = false to upload images in dated sub-directories (alike default Ghost Local storage adapter)
  • The auth property is optional if you use the CLOUDINARY_URL environment variable authentification method
  • The optional upload property contains Cloudinary API upload options
  • The optional fetch property contains Cloudinary API image transformation options

Recommended configuration

  • upload.use_filename = true in order use the original image name
  • upload.unique_filename = false unlikely Ghost local storage adapter which auto-dedup an existing file name, Cloudinary will return the existing image URL instead of deduping the image
  • upload.overwrite = false goes along with previous option: returns existing image instead of overwriting it
  • upload.folder = "my-blog" allows to upload all your images into a specific directory instead of Cloudinary media library root
  • upload.tags = ["blog", "photography"] if you want to add some taxonomy to your uploaded images
  • fetch.quality = "auto" equals auto:good (see doc)
  • fetch.secure = false set to true if you want to serve images over SSL (not recommended for performances)
  • fetch.cdn_subdomain = true to really use the benefit of Cloudinary CDN

❤️ Don't forget to checkout the plugins!

Development

Run npm install without the --production flag.

Runs the tests:

$ npm t

Generates the coverage:

$ npm run-script cover

Runs the linter:

$ npm run-script eslint

To enable debug logs, set the following environment variable:

DEBUG=ghost-storage-cloudinary:*

Many thanks to @mmornati, @sethbrasile and all other contributors for their work. In the continuation of this project, don't hesitate to fork, contribute and add more features.