@theverything/ghost-storage-s3
v0.0.2
Published
An AWS S3 storage adapter for Ghost 1.x - 3.x
Downloads
1
Readme
Ghost storage adapter S3
An AWS S3 storage adapter for Ghost 1.x - 3.x
Configuration
"storage": {
"active": "s3",
"s3": {
"accessKeyId": "YOUR_ACCESS_KEY_ID",
"secretAccessKey": "YOUR_SECRET_ACCESS_KEY",
"region": "YOUR_REGION_SLUG",
"bucket": "YOUR_BUCKET_NAME",
"assetHost": "YOUR_OPTIONAL_CDN_URL (See note 1 below)",
"signatureVersion": "REGION_SIGNATURE_VERSION (See note 5 below)",
"pathPrefix": "YOUR_OPTIONAL_BUCKET_SUBDIRECTORY",
"endpoint": "YOUR_OPTIONAL_ENDPOINT_URL (only needed for 3rd party S3 providers)",
"serverSideEncryption": "YOUR_OPTIONAL_SSE (See note 2 below)",
"forcePathStyle": true,
"acl": "YOUR_OPTIONAL_ACL (See note 4 below)",
"cacheControl": "YOUR_OPTIONAL_CACHE_CONTROL (See note 6 below)",
}
}
Note 1: Be sure to include "//" or the appropriate protocol within your assetHost string/variable to ensure that your site's domain is not prepended to the CDN URL.
Note 2: if your s3 bucket enforces SSE use serverSideEncryption with the appropriate supported value.
Note 3: if your s3 providers requires path style you can enable it with forcePathStyle
Note 4: if you use CloudFront the object ACL does not need to be set to "public-read"
Note 5: Support for AWS4-HMAC-SHA256
Note 6: How long to cache the image for (default is 30 days)
Via environment variables
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_DEFAULT_REGION
GHOST_STORAGE_ADAPTER_S3_PATH_BUCKET
GHOST_STORAGE_ADAPTER_S3_ASSET_HOST // optional
GHOST_STORAGE_ADAPTER_S3_PATH_PREFIX // optional
GHOST_STORAGE_ADAPTER_S3_ENDPOINT // optional
GHOST_STORAGE_ADAPTER_S3_SSE // optional
GHOST_STORAGE_ADAPTER_S3_FORCE_PATH_STYLE // optional
GHOST_STORAGE_ADAPTER_S3_ACL // optional
GHOST_STORAGE_ADAPTER_S3_CACHE_CONTROL // optional