docken v1.1.1

Docken 🐳

This is a library built on top of dockerode for interacting with the docker daemon. Besides, it enables scanning organized dockerfiles via FS.

🚧 Work in Progress

The library is currently under active development and is not yet ready for production.

Table of Contents

• Installation
• Usage
  • Daemon
  • FS Scan
• Contributing
• License

Installation

npm install docken --save

Usage

Daemon

...

FS Scan

Image

An image is in most cases represented by a Dockerfile in a directory. In some cases the image is also described with some meta information by an image descriptor file (image.json). But the descriptor file can also be a replacement for the Dockerfile.

Group

A group has the same base properties as an image. The only other difference is, that the descriptor file must be named group.json.

Meta

The meta object has the following 3 properties:

• path The path is the relative path on the host machine, with different path separators (windows: \\, linux: /) depending on the operating system.
• virtualPath The virtualPath is a path only containing group ids and the own image id, seperated with /.
• attributes The attributes property holds an object of optional data provided via image.json or group.json file.

Contributing

Before starting to work on a pull request, it is important to review the guidelines for contributing and the code of conduct. These guidelines will help to ensure that contributions are made effectively and are accepted.

License

Made with 💚

Published under MIT License.