If you've already been using the Serverless Framework for your development projects on AWS, you may have realized that deploying the frontend portion of your applications isn't built in.
Fortunately for you, the Serverless Framework is extensible. Meaning, there's a plugin for that: Serverless Finch.
In this post, I'll show you how you can use the Serverless Finch plugin to deploy your own static website assets in a way that is compatible with most modern frontend frameworks or less-complex static sites.
First off, if you haven't already, you'll need to:
- install the Serverless Framework
- configure AWS API keys that at least give you broad S3 permissions (If you've done any work with the Serverless Framework, you probably already have these)
- install Node.js and npm (I'm using node v6.10.3, but more modern versions should work too)
- prepare some static website files and put them in a folder called
client/distin the same folder as your Serverless Framework project
- create an
error.htmlfile to deploy to S3 as a default landing page and error page
Steps 4 and 5 are very customizable so I'll explain more about them in the advanced features section below.
1-2-3 Install, configure, deploy, done.
After you've completed the initial steps above, the deployment process should be quick and easy:
From within an existing Serverless Framework project directory, install the Serverless Finch plugin with
npm install --save serverless-finch.
Then, update your
serverless.yml file by adding this:
plugins: - serverless-finch custom: client: bucketName: your-unique-s3-bucketname
Warning step: Make sure that you have configured an S3 bucket purely dedicated to storing the files for this frontend. The plugin will delete and overwrite the current contents of the bucket.
Now, warning step completed, run
serverless client deploy and see the magic happen! Remember that by default the plugin looks for your already-built frontend code in
Don't have an
index.html or other website files yet? Here's a quick script you can run before
serverless client deploy just to give yourself a barebones page and see how things work:
mkdir -p client/dist touch client/dist/index.html client/dist/error.html echo "Go Serverless" >> client/dist/index.html echo "Sorry! This is an error page" >> client/dist/error.html
Because Serverless Finch can take potentially destructive actions (overwriting existing files, changing bucket policies, etc.) the plugin should now display a confirmation prompt prior to taking any action. After entering
Y for yes you should then see something like this:
Serverless: Bucket found... Serverless: Deleting all objects from bucket... Serverless: Configuring bucket... Serverless: Configuring policy for bucket... Serverless: Configuring CORS for bucket... Serverless: Uploading client files to bucket... Serverless: Success! Your site should be available at http://your-unique-s3-bucketname.s3-website-us-east-1.amazonaws.com/
After that, congrats! You've just deployed your static website. Go ahead and visit the domain shown to confirm your site was deployed.
Okay, so the basic tutorial was nice and all, but what if you want to set a custom distribution folder? Custom index and error documents? Or maybe use this with a custom domain? Here are a few common questions and answers for power users.
Can I make the distribution folder something other than
Yes. Just add a distributionFolder path value to the
serverless.yml file this:
custom: client: ... distributionFolder: location/of/files ...
Keep in mind that this path is relative to the location of
Can I set custom index and error documents?
Yes! Just add a line to serverless.yml for each:
custom: client: ... indexDocument: custom-index.html errorDocument: custom-error.html ...
Keep in mind that you will need to put these inside whatever distribution folder you configure though!
How does Serverless Finch integrate with custom domains?
Great question! We're currently considering additional functionality to help manage custom domains. Currently, you can register your own domain on Route 53 and then point that domain to the S3 bucket using an AWS A record alias (this requires the bucket to share the name with the custom domain).
You can also create a CloudFront Distribution to cache the files in your S3 bucket, and then point your custom domain to that CloudFront distribution with a Route 53 A record alias. The benefit of CloudFront is that you can also get a free HTTPS certificate and you can name your S3 bucket whatever you want.
Either way, I'd recommend you determine how to setup your custom domain based on what's best for your needs, and then use Serverless Finch to update and deploy the changes inside your S3 bucket (which should update your site regardless of the option you choose).
What other customizations can I make?
Lots! For a full list of features, you can view the project on GitHub. Don't see something that you think would be a useful feature? We are happy to add in your contributions!
About a year ago, I adopted and republished a broken Serverless Framework plugin that turned into Serverless Finch. Over the last year, the community has added a bunch of new features with more on the way.