Skip to content

Latest commit

 

History

History
158 lines (89 loc) · 4.84 KB

README.md

File metadata and controls

158 lines (89 loc) · 4.84 KB
Raw

ember-cli-deploy-cloudfiles

An ember-cli-deploy plugin to upload files to Rackspace Cloud Files

This plugin uploads one or more files to a single Rackspace Cloud Files container. It is most suited to upload the assets (js, css, images, fonts, etc.) into a container.

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 worak, please refer to the Plugin Documentation.

Quick Start

To get up and running quickly, do the following:

$ ember install ember-cli-deploy-cloudfiles
  • Place the following configuration into config/deploy.js
ENV.cloudfiles = {
  region: '<your-rackspace-region>',
  username: '<your-rackspace-username>',
  apiKey: '<your-rackspace-api-key>',
  container: '<your-rackspace-container-name>',
  headers: {
    'header-name': 'header-value'
  }
}
  • Run the pipeline
$ ember deploy

Installation

Run the following command in your terminal:

ember install ember-cli-deploy-cloudfiles

ember-cli-deploy Hooks Implemented

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

  • upload

Configuration Options

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

apiKey (required)

The Rackspace API key for the user that has the ability to upload to the container.

Default: undefined

username (required)

The Rackspace username of the user that has the ability to upload to the container.

Default: undefined

container (required)

The Rackspace Cloud Files container that the files will be uploaded to.

Default: undefined

region (required)

The Rackspace region you are working on.

Default: undefined

headers

The Rackspace Cloud Files headers for the uploaded file.

Default: undefined

prefix

A directory within the container that the files should be uploaded in to.

Default: ''

filePattern

Files that match this pattern will be uploaded to the container. The file pattern must be relative to distDir.

Default: \*\*/\*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}

distDir

The root directory where the files matching filePattern will be searched for. By default, this option will use the distDir property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distDir

distFiles

The list of built project files. This option should be relative to distDir and should include the files that match filePattern. By default, this option will use the distFiles property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distFiles

manifestPath

The path to a manifest that specifies the list of files that are to be uploaded to Cloud Files.

This manifest file will be used to work out which files don't exist on Cloud Files and, therefore, which files should be uploaded. By default, this option will use the manifestPath property of the deployment context, provided by [ember-cli-deploy-manifest][4].

Default: context.manifestPath

uploadClient

The client used to upload files to Cloud Files. This allows the user the ability to use their own client for uploading instead of the one provided by this plugin.

The client specified MUST implement a function called upload.

Default: the upload client provided by ember-cli-deploy-cloudfiles

cloudFilesClient

The underlying library used to upload the files to Cloud Files. This allows the user to use the default upload client provided by this plugin but switch out the underlying library that is used to actually send the files.

The client specified MUST implement functions called download and upload.

Default: the default library is pkgcloud

Prerequisites

The following properties are expected to be present on the deployment context object:

Running Tests

  • npm test