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

docker-exec-websocket-server

v3.0.0

Published

## Purpose A server that serves the results of docker exec over websockets.

Downloads

24

Readme

docker-exec-websocket-server

Purpose

A server that serves the results of docker exec over websockets.

See docker-exec-websocket-client for a client that communicates with this server.

Usage

Server:

var DockerServer = require('../lib/server.js');
var dockerServer = new DockerServer({
  port:8080, //automatically creates http server
  //OR
  server: //http.Serv object, can also be https, should already be listening

  path: '/'+slugid.v4(),    //Path to WebSocket
  containerId: 'servertest',  //Container to inject exec proccess into
  dockerSocket: '/var/run/docker.sock' //location of docker remote API socket
  maxSessions: 10 //maximum number of connected sessions
});
await dockerServer.execute();

By default, uses /var/run/docker.sock to communicate with Docker.

Message Types

Messages are prepended with a single byte which contains information about the encoded message. The payload is a Buffer in node, or a UInt8Array in browserify.

// stream related message types (carries a payload)
stdin: 0,
stdout: 1,
stderr: 2,
// data-flow related message types (carries no payload)
resume: 100, // Process is now ready to receive data
pause: 101, // Process is processing current data, don't send more right now
// resolution related message types
stopped: 200, // Process exited, payload is single byte exit code
shutdown: 201, // Server shut down
error: 202 // Some internal error occurred, expect undefined behaviour

Testing

Ensure Docker is installed (docker -v).

To test locally:

  • Run yarn install to install the dependencies, including developer dependencies
  • Run yarn test
  • You can pass environment variables and commands to mocha as well, such as DEBUG=* yarn test -f 'docker exec wc'

To test with docker-compose, similar to CI:

  • Run docker-compose build --build-arg NODE_VERSION=16-bullseye, or change to the desired Node.js image tag
  • Run docker-compose run --rm test
  • Repeat docker-compose build ... when the code changes or you want to try a different Node.js image.