Nifty Procrastination Machine

    docker-api

    0.7.0 • Public • Published

    docker.io

    Build Status Dep Status devDependency Status

    Node.JS wrapper for low-level Docker.io HTTP interface

    Usage

    Using unix sockets (most secure)

     
    // Sockets are used by default.
    var docker = require('docker-api')({ socketPath: '/var/run/docker.sock' });
     

    Using TCP connection

     
    // You must specify socketPath: false to indicate you want to use TCP connections.
    var docker = require('docker-api')({ socketPath: false, host: 'http://localhost', port: '4243'});
     

    The defaults for the connection options are:

    API calls

    Here is an example API call, more examples can be found here

     
    var options = {}; // all options listed in the REST documentation for Docker are supported.
     
    docker.containers.list(options /* optional*/, function(err, res) {
        if (err) throw err;
        console.log("data returned from Docker as JS object: ", res);
    });
     

    Contributing

    PULL REQUESTS ARE WELCOME!

    Concerned that your PR would change too much? File a ticket, I am willing to hear arguments for change :)

    License

    Copyright 2013 Apperson Labs, LLC http://appersonlabs.com matt@appersonlabs.com

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Keywords

    none

    Install

    npm i docker-api

    DownloadsWeekly Downloads

    0

    Version

    0.7.0

    License

    Apache 2

    Last publish

    Collaborators

    • pradeepmishra