https://github.com/lightsofapollo/dockerode-options
Parse dockerode options from a string for DOCKER_HOST and DIND use cases
https://github.com/lightsofapollo/dockerode-options
Last synced: about 1 year ago
JSON representation
Parse dockerode options from a string for DOCKER_HOST and DIND use cases
- Host: GitHub
- URL: https://github.com/lightsofapollo/dockerode-options
- Owner: lightsofapollo
- Created: 2014-01-22T07:59:43.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-12-09T04:19:13.000Z (over 10 years ago)
- Last Synced: 2025-03-25T17:13:53.301Z (over 1 year ago)
- Language: JavaScript
- Size: 256 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
dockerode-options
=================
Can both parse string based options (like 127.0.0.1:4243) for dockerode and find sensible defaults for connecting to docker.
## Usage
### With a string
```js
var dockerOpts = require('dockerode-options');
var Docker = require('dockerode');
// DOCKER_HOST = '127.0.0.1:4243'
var options = dockerOpts(process.env.DOCKER_HOST);
// => { host: 'http://127.0.0.1', port: 4243 }
// these can now be used to start dockerode
var docker = new Docker(options);
```
### With no options
```js
var dockerOpts = require('dockerode-options');
var options = dockerOpts();
// => { socketPath: '/var/run/docker.sock' }
```
### With DOCKER_HOST environment variable set
```js
var dockerOpts = require('dockerode-options');
process.env.DOCKER_HOST = '127.0.0.1:60022';
var options = dockerOpts();
// => { host: '127.0.0.1', port: 60022 };
```
### With DOCKER_CERT_PATH environment variable set
```js
var dockerOpts = require('dockerode-options');
process.env.DOCKER_CERT_PATH = '/home/certs';
var options = dockerOpts();
// => { ca: , cert: , key: };
```