Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

remote-forwarder

mcollina9MIT1.7.0

Forward a local port to a remote server in node, using SSH client

ssh, port, forward

readme

remote-forwarder

Forward a local port to a remote server, using SSH. It wraps ssh -R so that in can be used in node-land.

Install

npm install remote-forwarder --save

Usage

remote-forwarder inherits from Recovery, so it can keep the forwarding up even if it dies.

var forwarder = require('remote-forwarder')

var forward = forwarder({
    target: target // the target host
  , identityFile: identity // the SSH identity file, optional
  , user: user // the user in the target system
  , port: port // the local port to expose remotely
  , retries: 100 // the number of retries
  // plus all other Recovery options
})

forward.on('connect', function() {
  // this will be called any time a
  // new connection is established

  // do stuff here ...

  forward.stop() // to stop forwarding
})

forward.start()

Acknowledgements

This project was kindly sponsored by nearForm.

License

MIT