Ssh

Ssh

Class to allow connecting to a DB through an ssh tunnel

Constructor

new Ssh(configopt)

Specify connection details including, host, port, user, privateKey

Source:
Parameters:
Name Type Attributes Description
config Object <optional>

Configuration to send to npm's ssh2

Methods

end()

Close the ssh tunnel

Source:

tunnelTo(db) → {Promise}

Setup a tunnel for the given Db instance

Source:
Parameters:
Name Type Description
db Db

A Db instance
Returns:
Type:
Promise

Resolves when tunnel is established