Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ghost-storage-s3

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ghost-storage-s3

Store Ghost's images on S3 and proxy requests for local images to S3.

  • 2.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

Ghost S3 Storage, compatability mode

This module allows you to read and write images from Amazon S3 instead of storing them locally.

After installing, new images that you save will use an absolute URL to S3. Any requests to /content/images/ will be proxied to S3, so that any previous images in your blog will not be affected.

Installation

You will need to have a the custom storage module directly in your project directory, the easiest way to do this is to change to the directory your ghost installation and execute the following commands:

$ npm install ghost-storage-s3
$ npm shrinkwrap

Create Storage Module

Create a directory to store your custom storage module:

$ sudo mkdir -p content/storage/ghost-s3

In the ghost-s3/ directory you need to create a file named index.js with the following contents:

'use strict';
module.exports = require('ghost-storage-s3');

Configuration

Create new IAM User with permissions to get object from that bucket. Save the ACCESS_KEY and SECRET_ACCESS_KEY.

In config.js, add a storage block for each environment. A list of valid regions can be accessed in the AWS General Reference of S3 AWS Regions and Endpoints.

    storage: {
        active: 'ghost-s3',
        'ghost-s3': {
            accessKeyId: 'ACCESS_KEY',
            secretAccessKey: 'SECRET_ACCESS_KEY',
            bucket: 'S3_BUCKET_NAME',
            region: 'S3_REGION'
        }
    }

Asset Host

You can add assetHost to your config to specify a virtual host url. This is most frequently used with a content delivery network (CDN) such as CloudFront, CloudFlare, or others. The modified storage block would be:

    storage: {
        active: 'ghost-s3',
        'ghost-s3': {
            accessKeyId: 'ACCESS_KEY',
            secretAccessKey: 'SECRET_ACCESS_KEY',
            bucket: 'S3_BUCKET_NAME',
            region: 'S3_REGION',
            assetHost: 'https://cdn.yourdomain.com/'
        }
    }

For more information, read the Virtual Hosting of Buckets section of the AWS S3 Developer Guide.

  • Original work Copyright (c) 2015 Hoang Pham Huu phamhuuhoang@gmail.com
  • Modified work Copyright (c) 2016 Curiosity Media, Inc.
  • Modified work by Frank Hinek

Released under the MIT license.

Keywords

FAQs

Package last updated on 08 Jul 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc