Go to file
2017-04-02 12:11:21 +02:00
dist update 2017-03-26 13:02:20 +02:00
docs improve README 2017-04-02 12:05:29 +02:00
test improve README 2017-04-02 12:05:29 +02:00
ts update 2017-03-26 13:02:20 +02:00
.gitignore improve README 2017-04-02 12:05:29 +02:00
.gitlab-ci.yml update ci 2017-04-02 12:11:21 +02:00
.npmignore start Dockerfile for tests 2016-06-14 08:49:13 +02:00
docker-compose.yml add tests with in docker 2016-06-16 04:18:10 +02:00
LICENSE Initial commit 2016-04-12 12:40:06 +02:00
npmextra.json update npmextra to have npmts and npmdocker available in ci 2017-04-02 12:08:36 +02:00
package.json update 2017-03-26 13:02:20 +02:00
README.md improve README 2017-04-02 12:05:29 +02:00
yarn.lock update 2017-03-26 13:02:20 +02:00

dockersock

easy communication with docker remote api from node, TypeScript ready

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import {Dockersock} from "dockersock"; // require Dockersock class

let myDockersock = new Dockersock(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock

myDockersock.listContainers() // promise, resolve gets container data
myDockersock.listContainersDetailed() // promise, resolve gets more detailed container data (by combining several requests internally)
myDockersock.listContainersRunning() // promise, resolve gets container data for currently running containers
myDockersock.listContainersStopped() // promise, resolve gets container data for stopped containers

myDockersock.startContainer({ // starts a already present container
    name: "somecontainername"
})

myDockersock.newContainer({ // start new Container, equals "docker run" shell command
    image: "someimagetag"
})

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer