# Ember-deploy-ssh-index

This README outlines the details of collaborating on this Ember addon.

## Installation

* `git clone` this repository
* `npm install`
* `bower install`

## Running

* `ember server`
* Visit your app at http://localhost:4200.

## Running Tests

* `ember test`
* `ember test --server`

## Building

* `ember build`

For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).

# ember-deploy-ssh-index

This is an [ember-cli-deploy][] adapter for deploying your index page to a server via SSH.

## Installation

* `npm install --save-dev ember-deploy-ssh-index`

## Configuration

To use this plugin, set `type` to `"ssh"` in your [ember-cli-deploy][] configuration.

The following configuration options are supported by this plugin:

- `host`: SSH host server (e.g. myserver.com)
- `username`: SSH user (e.g. root)
- `remoteDir`: Remote directory to upload index pages (e.g. /var/www)
- `privateKeyFile`: local private key file to use for SSH connection (e.g. /home/user/.ssh/id_rsa)

To set configuration variables, follow the instructions in the [ember-cli-deploy][] documentation.

Example `config/deploy.js` file using ember-deploy-ssh-index with [ember-deploy-s3][]:

```
/* jshint node: true */

module.exports = {
  production: {
    store: {
      type: "ssh",
      remoteDir: "/var/www/",
      host: "example.com",
      username: "root",
      privateKeyFile: process.env.SSH_KEY_FILE,
    },
    assets: {
      type: "s3",
      accessKeyId: process.env.AWS_KEY,
      secretAccessKey: process.env.AWS_SECRET,
      bucket: "assets.example.com",
    }
  }
};
```

You will probably need to prefix your static asset links with a URL based on your asset deploy plugin.  For example if you are using [ember-deploy-s3][] with a bucket named `assets.example.com` you might fingerprint like this:

var app = new EmberApp({
  fingerprint: {
    prepend: 'https://s3.amazonaws.com/assets.example.com/',
  },
});


## Usage

* Deploy to production: `ember deploy -e production`
* List deployed revisions: `ember deploy:list -e production`
* Activate a revision: `ember deploy:activate --revision <tag> -e production`

## Running Tests

**Note:** there are no tests currently!

* `ember test`
* `ember test --server`

[ember-cli-deploy]: https://github.com/ember-cli/ember-cli-deploy
[ember-deploy-s3]: https://github.com/LevelbossMike/ember-deploy-s3

Add install, config, and deploy instructions
Add install, config, and deploy instructions
