https://github.com/coderaiser/node-docker-init
init docker with parameters
https://github.com/coderaiser/node-docker-init
docker nodejs
Last synced: 9 months ago
JSON representation
init docker with parameters
- Host: GitHub
- URL: https://github.com/coderaiser/node-docker-init
- Owner: coderaiser
- Created: 2016-03-25T17:12:48.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T17:02:42.000Z (over 7 years ago)
- Last Synced: 2025-05-29T05:06:31.604Z (10 months ago)
- Topics: docker, nodejs
- Language: JavaScript
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
Awesome Lists containing this project
README
# Docker Init [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
Init [docker](https://docker.com "Docker") with [dockerode](https://github.com/apocas/dockerode "Dockerode") parameters.
## Install
```
npm i docker-init --save
```
## How to use?
`docker init` takes options with 3 properties:
- **socketPath** - `/var/run/docker.sock` by default
- **host** - host of docker machine, could be used `$DOCKER_HOST` or any host in format `:`, e.g. `192.168.99.100:2376`.
- **certPath** - path to read certificates (`key.pem`, `ca.pem`, `cert.pem`) from, could be used `$DOCKER_CERT_PATH`.
```js
let dockerInit = require('docker-init');
// on local linux
docker = dockerInit();
// on mac os or windows, with default docker install
docker = dockerInit({
host : process.env.DOCKER_HOST,
certPath : process.env.DOCKER_CERT_PATH
});
// now you can use Dockerode API
```
## License
MIT
[NPMIMGURL]: https://img.shields.io/npm/v/docker-init.svg?style=flat
[BuildStatusIMGURL]: https://img.shields.io/travis/coderaiser/node-docker-init/master.svg?style=flat
[DependencyStatusIMGURL]: https://img.shields.io/david/coderaiser/node-docker-init.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/docker-init "npm"
[BuildStatusURL]: https://travis-ci.org/coderaiser/node-docker-init "Build Status"
[DependencyStatusURL]: https://david-dm.org/coderaiser/node-docker-init "Dependency Status"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/coderaiser/node-docker-init?branch=master
[CoverageIMGURL]: https://coveralls.io/repos/coderaiser/node-docker-init/badge.svg?branch=master&service=github