openvpn-bin
Initialize a openvpn instance for mac, windows & linux
Last updated 5 years ago by luigiplr .
GPL-3.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install openvpn-bin 
SYNC missed versions from official npm registry.

openvpn-bin

npm version

Initialize a Open Vpn Instance on Mac, Windows & Linux

Installation

npm install openvpn-bin --save

Documentation

Constructor

Argument: vpnOpts Object passed to .initialize()

{
  host: '127.0.0.1', //management console host, defualts to 127.0.0.1 
  port: 1337, //set the port for the management console, recommended this is omited so openvpn-bin finds available port for you
  scriptSecurity: 2,  //defualts to 2
  config: 'config.ovpn', //path of openvpn config file, defualts to config.ovpn
  cwd: process.cwd(), //set the current working directory for openvpn, defualts to process.cwd()
  up: '', //optional, should be only used for mac and linux (for dns)
  down: '' //optional, should be only used for mac and linux (for dns)
}

Argument: openvpnPath String passed to .initialize() with absolute or relative path to openvpn executable

path.normalize('../bin/openvpn.exe')

.initialize()

Returns Promice on sucsessfull startup of openvpn:

{
  port: spesifyed or auto found port,
  host: spesifyed or defualt 127.0.0.1
}

.shutdown()

It returns a Promise that is fulfilled when OpenVpn instance is terminated

module.initialize([openvpnPath],[vpnOpts])

Initialize OpenVpn Instance using [openvpnPath] [vpnOpts] arguments

Support

If you're having any problem, please raise an issue on GitHub and I'll be happy to help.

Contribute

License

The project is licensed under the GPL-3.0 license.

Current Tags

  • 0.1.2                                ...           latest (5 years ago)

11 Versions

  • 0.1.2                                ...           5 years ago
  • 0.1.1                                ...           5 years ago
  • 0.1.0                                ...           5 years ago
  • 0.0.9                                ...           5 years ago
  • 0.0.8                                ...           5 years ago
  • 0.0.7                                ...           5 years ago
  • 0.0.6                                ...           5 years ago
  • 0.0.5                                ...           5 years ago
  • 0.0.4                                ...           5 years ago
  • 0.0.3                                ...           5 years ago
  • 0.0.1                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (4)
Dev Dependencies (1)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |