/node-protonvpn

Primary LanguageTypeScript

🔥 node-protonvpn 🔥 Become a Stargazer

Connect to protonvpn servers through a simple nodejs api

Installation

# with npm
npm install node-protonvpn
# with yarn
yarn add node-protonvpn

Usage

// configs can be found at https://account.protonvpn.com/downloads
// - under country configs
// - download all
const configDir = "dir/to/configs";

// optional - fix config compression error
fixConfigCompressionErrorDir(configDir);

// can be found at https://account.protonvpn.com/account
const auth: OpenVpnAuth = {
    user: "opevpn username",
    pass: "openvpn password",
};

const protonVpn = new ProtonVpnController(configDir, auth, {
    enableLogging: true,
});

protonVpn.connect("US");

IMPORTANT: You must have openvpn installed on your machine and run node as administrator on windows (linux not tested)

Contributing

Prerequisites

  • node (lts version)
  • yarn (1.^22.10)

Setup

# clone repo
git clone https://github.com/freddie-nelson/node-protonvpn
cd node-protonvpn

# install dependencies
yarn

# start dev server
yarn dev

# run build
node dist/index.esm.js

License

MIT

Copyright © 2020 - Present, Freddie Nelson

Contact