-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
147 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,46 @@ | ||
# dockerode-compose | ||
# dockerode-compose | ||
|
||
docker-compose in Node.js using [dockerode](https://github.com/apocas/dockerode). | ||
|
||
Work in progress... | ||
|
||
## Installation | ||
|
||
`npm install dockerode-compose` | ||
|
||
|
||
### Getting started | ||
|
||
To use `dockerode-compose` first you need to instantiate it: | ||
|
||
``` js | ||
var Dockerode = require('dockerode'); | ||
var DockerodeCompose = require('dockerode-compose'); | ||
|
||
var docker = new Dockerode(); | ||
var compose = new DockerodeCompose(docker); | ||
|
||
(async () => { | ||
var state = await compose.compose('./test/wordpress.yml', 'wordpress'); | ||
console.log(state); | ||
})(); | ||
``` | ||
|
||
## Tests | ||
|
||
* `docker pull ubuntu:latest` to prepare your system for the tests. | ||
* Tests are implemented using `mocha` and `chai`. Run them with `npm test`. | ||
|
||
## Examples | ||
|
||
Check the examples folder for more specific use cases examples. | ||
|
||
## License | ||
|
||
Pedro Dias - [@pedromdias](https://twitter.com/pedromdias) | ||
|
||
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.html | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,24 @@ | ||
{ | ||
"name": "dockerode-compose", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "docker-compose in nodejs using dockerode", | ||
"main": "lib/compose.js", | ||
"main": "./lib/compose.js", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/apocas/dockerode-compose.git" | ||
}, | ||
"author": "", | ||
"license": "ISC", | ||
"author": "Pedro Dias <[email protected]>", | ||
"license": "Apache-2.0", | ||
"bugs": { | ||
"url": "https://github.com/apocas/dockerode-compose/issues" | ||
}, | ||
"keywords": [ | ||
"docker", | ||
"docker-compose" | ||
], | ||
"homepage": "https://github.com/apocas/dockerode-compose#readme", | ||
"dependencies": { | ||
"dockerode": "^3.2.1", | ||
|