Ember-cli-deploy-ssh-tunnel

An ember-cli-deploy plugin to open an ssh tunnel during your deploy

**WARNING: This plugin is only compatible with ember-cli-deploy versions >= 0.5.0**

This plugins opens an ssh tunnel forwarding a port to the host you specify to one of your local ports.

A typical use case is to pair this plugin with the ember-cli-deploy-redis plugin to reach to redis servers that for security reasons are not listening to their public IP.

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:

Install this plugin

$ ember install ember-cli-deploy-ssh-tunnel

Place the following configuration into config/deploy.js

ENV['ssh-tunnel'] = {
  username: 'yourname',
  host: 'yourserver',
};

Run the pipeline

$ ember deploy

Installation

Run the following command in your terminal:

ember install ember-cli-deploy-ssh-tunnel

ember-cli-deploy Hooks Implemented

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

configure
willUpload
didUpload

Configuration Options

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

username (`required`)

The user for the ssh connection

Default: undefined

host (`required`)

The server to connect to

Default: undefined

dstPort

The port to forward from the server

Default: 6379

dstHost

The host to forward to on the destination server.

Default: localhost

srcPort

The local port for the forwarding

Default: a random port between 49151 and 65535

privateKeyPath

The local path to your ssh private key

Default: ~/.ssh/id_rsa

tunnelClient

The client used to create the ssh tunnel. This allows the user the ability to use their own client for uploading instead of the one provided by this plugin.

Default: the tunnel provided by tunnel-ssh

Running Tests

npm test

Thanks to:

@lukemelia and @achambers and the other folks from the ember-cli-deploy project.

@tim-evans for the original implementation in ember-deploy-redis

fklingler / ember-cli-deploy-ssh-tunnel Goto Github PK