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

dockership

v2.2.1

Published

Scriptable docker management tool build upon Docker remote API.

Downloads

9

Readme

Dockership

Scriptable docker management tool build upon Docker remote API.

Usage

1. Get Start

var Dockership = require('dockership');

var dockerConfig = {
  ca:   'path/to/ca', // Can also be a Buffer of ca.pem
  cert: 'path/to/cert',
  key:  'path/to/key',
  host: '0.0.0.0',
  port: 2376
};

var ship = new Dockership({
  docker: dockerConfig, // Config obj used to construct docker remote client
  buildContext: 'path/to/dockerfile/parent/dir', // Absolute, or relative to cwd
  meta: metaConfig // Information describing docker images and how to run containers
});

2. API

Dockership use dockerode and bluebird internally. All API calls will return a bluebird promise.

images method

Resolve with remote images specified by metaConfig.

ship.images().then(function (images) {
  console.log(images); // JSON
});

containers method

ship.containers().then(function (containers) {
  console.log(containers); // JSON
});

build method

ship.build().then(function (image) {
  console.log(image); // JSON
});

ship instance is an EventEmitter instance. You can listen to events emitted during build process.

ship.on('buildMessage', function (obj) {
  // Log something
});

Dockership comes with logger helper to help log buildMessage to console.

var logger = Dockership.makeLogger();
ship.on('buildMessage', logger);

logger can be customized by passing a modifier function:

var logger = Dockership.makeLogger(function (str) {
  return 'Prefix ' + str;
});

ship.on('buildMessage', logger); // Prepend "Prefix " to every line of message

start method

ship.start().then(function (container) {
  console.log(container); // JSON
});

By default, start will start stopped container or create container from image specified in metaConfig. If such container or image cannot be found, start will reject.

stop method

Stop will stop all containers match the description in metaConfig.

ship.stop().then(function (containers) {
  console.log(containers); // JSON
});

exec method

Execute command inside container. Reject if running container cannot be found.

ship.exec().then(function () {
  // No argument
});

this context

All promise callback have this refer to current ship instance.

ship
  .build()
  .then(function (image) {
    return this.start();
  })
  .then(function (container) {

  });

TODO

  • Improve event emitting, especially error emitting.