An ember-cli-deploy plugin for deploying an Ember app to AWS Elastic Beanstalk running FastBoot.
JavaScript HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
addon
app
assets
config
lib
tests
vendor
.bowerrc
.editorconfig
.ember-cli
.eslintrc.js
.gitignore
.jshintrc
.npmignore
.travis.yml
.watchmanconfig
LICENSE.md
README.md
bower.json
ember-cli-build.js
index.js
package.json
testem.json

README.md

ember-cli-deploy-elastic-beanstalk

An ember-cli-deploy plugin for deploying an Ember app to AWS Elastic Beanstalk running FastBoot. Designed to be used in tandem with fastboot-aws.

This plugin builds your application for FastBoot server-side rendering, then uploads a zip of the build to Amazon S3.

Requires Node.js v4 or later.

What is an ember-cli-deploy plugin?

A plugin is an addon that can be executed as a part of the ember-cli-deploy pipeline. A plugin will implement one or more of the ember-cli-deploy's pipeline hooks.

For more information on what plugins are and how they work, please refer to the Plugin Documentation.

Quick Start

To get up and running quickly, do the following:

  • Configure your ember-cli-deploy pipeline for deploying to a CDN as usual. I recommend ember-cli-deploy-s3 with CloudFront.
  • Install this plugin
$ ember install ember-cli-deploy-elastic-beanstalk
  • Place the following configuration into config/deploy.js
ENV['elastic-beanstalk'] = {
  bucket: '<your-s3-bucket>'
}
  • Run the pipeline
$ ember deploy

Installation

Run the following command in your terminal:

ember install ember-cli-deploy-elastic-beanstalk

A Note on AWS Permissions

This plugin relies on the official AWS SDK to perform uploads to S3. As such, it will inherit any credentials you have saved by running aws configure via the AWS CLI.

For managing multiple credentials, I recommend using the officially-supported profiles feature of AWS.

To create a new profile, make sure you've installed the AWS CLI and then run:

aws configure --profile acme-corp

Enter your access key, secret key and other information requested. Once done, this will create a profile called acme-corp.

To do a deploy with this saved credential profile, invoke the command with the AWS_PROFILE environment variable set:

AWS_PROFILE=acme-corp ember deploy

ember-cli-deploy Hooks Implemented

For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.

  • build
  • didBuild
  • willUpload
  • upload

Configuration Options

For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.

bucket (required)

The AWS bucket that the FastBoot build will be uploaded to.

Default: undefined

environment

The environment target for the FastBoot build. Can be one of "development" or "production".

Default: production

outputPath

The path to the directory you'd like the FastBoot build to be built in to.

Default: tmp/fastboot-dist

zipPath

The path to the zip file that should be created from the outputPath.

Default: tmp/fastboot-dist.zip

filesToExclude

Files that match this pattern will be excluded from the zip. For instance to exclude files with .map extension pass: '\*.map'.

Default: ''

skipNpmInstall

Does not run npm install as part of the build procedure if set to true.

Default: false

Thanks

A big thank you to Luke Melia for helping me refactor my deploy script into an ember-cli-deploy plugin and to the entire ember-cli-deploy core team for answering my many questions.