# Manage Docker-Compose via Node.js
docker-compose is a small library that allows you to run docker-composeopen in new window (which is still required) via Node.js. This is useful to bootstrap test environments.
# Installation
npm install --save-dev docker-compose
+# Usage
docker-compose current supports these commands:
buildAll(options)- Build or rebuild servicesbuildMany(services, options)- Build or rebuild servicesbuildOne(service, options)- Build or rebuild serviceconfig(options)- Validates configuration files and returns configuration yamlconfigServices(options)- Returns list of services defined in configuration filesconfigVolumes(options)- Returns list of volumes defined in configuration filesdown(options)- Stops containers and removes containers, networks, volumes, and images created byupexec(container, command, options)- Execcommandinsidecontainer- uses-Tto properly handle stdin & stdoutkill(options)- Force stop service containerslogs(services, options)- Show logs of service(s) - useoptions.followtrue|falseto turn on--followflagpauseOne(service, options)- Pause the specified serviceport(service, containerPort, options)- Returns the public port of the given service and internal port.ps(options)- Lists containers informationpullAll(options)- Pull all service imagespullMany(services, options)- Pull service images specifiedpullOne(service, options)- Pull a service imagerestartAll(options)- Restart all servicesrestartMany(services, options)- Restart servicesrestartOne(service, options)- Restart servicerm(options, services)- Remove stopped service containers - always uses the-fflag due to non interactive mode -servicescan optionally be used to select the containers to removerun(service, command, options)- Run a one-offcommandon a service - uses-Tto properly handle stdin & stdoutstop(options)- Stop running containers without removing themstopOne(service, options)- Stops one container without removing itunpauseOne(service, options)- Resume the specified serviceupAll(options)- Builds, (re)creates, starts, and attaches to containers for all services - always uses the-dflag due to non interactive modeupMany(services, options)- Builds, (re)creates, starts, and attaches to containers for the services specified inservices- always uses the-dflag due to non interactive modeupOne(service, options)- Builds, (re)creates, starts, and attaches to containers for a service specified inservice- always uses the-dflag due to non interactive modeversion(options)- Showdocker-composeversion strings
All commands return a Promise({object}) with stdout and stderr strings and an exit code:
{
+ out: 'stdout contents',
+ err: 'stderr contents',
+ exitCode: 0, // !== 0 in case of an error
+}
+2
3
4
5
Although the return type is a Promise, it is still possible to get the process progres before the Promise resolves, by passing a callback function to the optional callback parameter.
# Example
To start service containers based on the docker-compose.yml file in your current directory, just call compose.up like this:
compose.upAll({ cwd: path.join(__dirname), log: true })
+ .then(
+ () => { console.log('done')},
+ err => { console.log('something went wrong:', err.message)}
+ );
+2
3
4
5
To get process progres
compose.upAll({
+ cwd: path.join(__dirname),
+ callback: (chunk: Buffer) => {
+ console.log('job in progres: ', chunk.ToString())
+ }
+ })
+ .then(
+ () => { console.log('job done')},
+ err => { console.log('something went wrong:', err.message)}
+ );
+2
3
4
5
6
7
8
9
10
To execute command inside a running container
compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
+# Options
docker-compose accepts these params:
cwd {string}: mandatory folder path to thedocker-compose.ymlexecutablePath {string}: optional path to docker-compose executable in case it's not located in $PATH/path/to/docker-composeconfig {(string|string[])}: custom and/or multiple yml files can be specified (relative tocwd)configAsString {string}: configuration can be provided as is, instead of relying on a file. In caseconfigAsStringis providedconfigwill be ignored.[log] {boolean}: optional setting to enable console logging (output ofdocker-composestdout/stderroutput)[composeOptions] string[]|Array<string|string[]: pass optional compose options like"--verbose"or[["--verbose"], ["--log-level", "DEBUG"]]or["--verbose", ["--loglevel", "DEBUG"]]for all commands.[callback] (chunk: Buffer, sourceStream?: 'stdout' | 'stderr') => void: optional callback function, that provides infromation about the process while it is still runing.[commandOptions] string[]|Array<string|string[]: pass optional command options like"--build"or[["--build"], ["--timeout", "5"]]or["--build", ["--timeout", "5"]]for theupcommand. ViablecommandOptionsdepend on the command (up,downetc.) itself
# Running the tests
While docker-compose runs on Node.js 6+, running the tests requires you to use Node.js 8 as they make use of async/await.
yarn test
+# Want to help?
This project is just getting off the ground and could use some help with cleaning things up and refactoring.
If you want to contribute - we'd love it! Just open an issue to work against so you get full credit for your fork. You can open the issue first so we can discuss and you can work your fork as we go along.
If you see a bug, please be so kind as to show how it's failing, and we'll do our best to get it fixed quickly.
Before sending a PR, please create an issueopen in new window to introduce your idea and have a reference for your PR.
We're using conventional commitsopen in new window, so please use it for your commits as well.
Also please add tests and make sure to run yarn lint.
# Discussions
If you want to discuss an docker-compose issue or PR in more detail, feel free to start a discussionopen in new window.
# License
MIT License
Copyright (c) 2017 - 2021 PDMLab
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.