dockerode-compose
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "dockerode-compose", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "docker-compose in nodejs using dockerode", | ||
"main": "./lib/compose.js", | ||
"main": "./compose.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
"test": "./node_modules/mocha/bin/mocha -R spec --exit" | ||
}, | ||
@@ -26,3 +26,8 @@ "repository": { | ||
"js-yaml": "^4.0.0" | ||
}, | ||
"devDependencies": { | ||
"chai": "~4.2.0", | ||
"memorystream": "~0.3.0", | ||
"mocha": "^7.1.0" | ||
} | ||
} |
# dockerode-compose | ||
docker-compose in Node.js using [dockerode](https://github.com/apocas/dockerode). | ||
`docker-compose` in Node.js using [dockerode](https://github.com/apocas/dockerode). | ||
Everything is executed programmatically using `dockerode`, consequently Docker's API. | ||
Work in progress... | ||
Wordpress example builds successfully. | ||
### ToDo: | ||
* HostConfig (and other spec) needs to be finished. | ||
* User friendly functions (partial deploys, etc) needs to be implemented. | ||
## Installation | ||
@@ -14,3 +22,3 @@ | ||
To use `dockerode` first you need to instantiate it: | ||
To use `dockerode-compose` first you need to instantiate it: | ||
@@ -25,3 +33,3 @@ ``` js | ||
(async () => { | ||
var state = await compose.compose('./test/wordpress.yml', 'wordpress'); | ||
var state = await compose.up('./test/wordpress.yml', 'wordpress'); | ||
console.log(state); | ||
@@ -31,5 +39,9 @@ })(); | ||
## Documentation | ||
- compose.up(file, project_name) | ||
- compose.pull(service) | ||
## Tests | ||
* `docker pull ubuntu:latest` to prepare your system for the tests. | ||
* Tests are implemented using `mocha` and `chai`. Run them with `npm test`. | ||
@@ -36,0 +48,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
24924
16
287
0
59
3
3