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

nm-vpn-rest

v0.2.0

Published

REST API frontend to node-nm-vpn

Downloads

8

Readme

nm-vpn-rest

RESTful API frontend to node-nm-vpn. Please see that module's page for important setup information.

Setup

Copy config.example.json to config.json and set the values as desired:

{
	"secure": false,
	"host": "my-server.name",
	"port": 3000,
	"allowedClients": {
		"http://my-server.name:8080"
	}
}

Hints:

  • allowedClients is an origin whitelist for the cors. I use the nm-vpn-web web app served on the same Raspberry Pi as this app runs; in this case I only need one origin. If, however, you wish to use the API in web apps from various devices then you'll need to ad each origin to this list to avoid CORS errors (if you're building non-web clients, e.g. Cordova applications, then you obviously need to worry about CORS; indeed, the whitelist will not prevent non-web clients from connecting)
  • secure toggles the use of HTTPS.

Usage

API entry point (lists connections with links to individual resource):

GET /connections

Retrieve a individual connection resource:

curl -X GET /connections/b1ed3626-80f1-11e5-8bcf-feff819cdc9f

Bring a connection up:

curl -X PUT http://my-server.name:3000/connections/b1ed3626-80f1-11e5-8bcf-feff819cdc9f -h 'Content-Type: application/json' -d '{"up": false}'

Take a connection down:

curl -X PUT http://my-server.name:3000/connections/b1ed3626-80f1-11e5-8bcf-feff819cdc9f -h 'Content-Type: application/json' -d '{"up": false}'

(I know, The above should be using PATCH; I'll get to it).