Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

node-protonvpn

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

node-protonvpn

A simple node api to connect to protonvpn.

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

🔥 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

Keywords

FAQs

Package last updated on 13 Aug 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc