node-openvpn-bin
v0.1.4
Published
a fork from luigiplr/openvpn-bin Initialize a openvpn instance for mac, windows & linux
Downloads
6
Maintainers
Readme
openvpn-bin
Initialize a Open Vpn Instance on Mac, Windows & Linux.
Designed to be used with node-openvpn.
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
- Issue Tracker: github.com/luigiplr/openvpn-bin/issues
- Source Code: github.com/luigiplr/openvpn-bin
License
The project is licensed under the GPL-3.0 license.