Git Product home page Git Product logo

ssh-tunneler's Introduction

ssh-tunneler Build Status

Plugin for gemini and hermione to set up ssh tunnel while running tests.

Install

$ npm install ssh-tunneler

Configuration

  • host (mandatory) String โ€“ address of a remote host to which ssh tunnel will be established
  • ports (mandatory) Object - ports range on a remote host; port will be picked randomly from this range
    • min Number โ€“ min port number
    • max Number - max port number
  • localport (mandatory) Number - available port on a local machine
  • user (optional) String - user to connect to a remote host
  • sshPort (optional) Number - port which should be used to create ssh tunnel, default is 22
  • retries (optional) Number - the number of attempts to establish a tunnel, default is 5
  • protocol (optional) String - protocol which will be used in a resulting base url, default is http
  • enabled (optional) Boolean - switch on/off the plugin; the plugin is switched on by default.
  • urlDecorator (optional) Function - provides the ability to decorate a resulting base url; function accepts two arguments - 1) a current value of a base url, 2) an instance of a created ssh tunnel

Usage

gemini

Add the plugin to your configuration file:

module.exports = {
    system: {
        plugins: {
            'ssh-tunneler/gemini': {
                // configuration
            }
        }
    }
};

hermione

Add the plugin to your configuration file:

module.exports = {
    plugins: {
        'ssh-tunneler/hermione': {
            // configuration
        }
    }
};

ssh-tunneler's People

Contributors

egavr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.