npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vercel/wireguard

v0.0.7

Published

Wireguard client packaged as an npm module

Downloads

7

Readme

@vercel/wireguard

Wireguard client packaged as an npm module.

Usage

Note This package currently only supports the Linux platform as it is intended to be used in Vercel Serverless Functions.

Import

import { wireguard } from '@vercel/wireguard';

socks-proxy-agent

import { SocksProxyAgent } from 'socks-proxy-agent';

const proxy = await wireguard();
const agent = new SocksProxyAgent();

Configuration

All properties are optional, the following values are the defaults.

/**
 * The return value is the local proxy URL, which in this case
 * would be `socks5://localhost:25344`.
 */
const proxy = await wireguard({
  /**
   * The client configuration, this is
   * used to specify options for the local proxy server.
   */
  client: {
    /**
     * The local port on which to expose the proxy.
     */
    port: 25344,

    /**
     * The private key to use when handshaking with
     * the remote Wireguard server.
     */
    privateKey: process.env.WIREGUARD_CLIENT_PRIVATE_KEY
  },

  /**
   * The path where the generated Wireguard configuration
   * file should be written.
   */
  configuration: '/tmp/wireguard.conf',

  /**
   * The server configuration, this is
   * used to specify options for the remote
   * Wireguard server.
   */
  server: {
    /**
     * The host of the remote Wireguard server, can be
     * and IP address or a DNS name.
     */
    host: process.env.WIREGUARD_SERVER_HOST,

    /**
     * The port on which the remote Wireguard server is
     * listening on.
     */
    port: 4343,

    /**
     * The public key of the remote Wireguard server, used
     * when handshaking.
     */
    publicKey: process.env.WIREGUARD_SERVER_PUBLIC_KEY,
  }
});