serverless-plugin-static-website v1.1.0

Serverless Static Website

A serverless plugin to create an S3 bucket to hosting your static website, it will automatically set public permissions and provide a specific deploy command.

Usage

Installation

$ npm install serverless-plugin-static-website --save-dev

or using yarn

$ yarn add serverless-plugin-static-website

Configuration

plugins:
  - serverless-plugin-static-website

custom:
  frontend: 
    bucket: ${self:service}-${self:provider.stage} # Provide a bucket name
    dir: './frontend' # Set frontend directory to publish
    cacheControl: '31536000' # Set max-age cache control, default: 31536000
    deploy: 'sync' # Set deploy strategy to cp (upload every time all files), or sync (upload only newer files), default: sync

Bucket information

At the end of serverless deploy you will see inside "Service Information" section the websites bucket's URL:

Service Information
service: myservice
stage: dev
region: eu-west-1
stack: myservice-dev
resources: 6
frontend: http://myservice-test.s3-website-eu-west-1.amazonaws.com <-- here thr URL to visit
api keys:
  None
endpoints:
  None
functions:
  hello: myservice-test-hello
layers:
  None

Commands

Deploy files

Deploy static websites files:

$ serverless deploy frontend

this will sync your configured frontend directory with S3 bucket.

Note: this command is a wrapper of aws s3 cp <local path> <bucket> --recursive, so you must have the AWS CLI installed.

Empty bucket

Remove all objects from bucket:

$ serverless remove frontend

Cleaning

When you destroy the environment with serverless remove the created bucket will be emptied automatically to permit the deletion.

TODO

• Create bucket
• Deploy on bucket
• Empty bucket during serverless remove phase
• Support bucket renaming
• Support multiples deploy strategies
• Add CloudFront configurations