• Stars
    star
    184
  • Rank 209,187 (Top 5 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Manage Docker-Compose via Node.js

Conventional Commits Discord

Manage Docker-Compose via Node.js

docker-compose is a small library that allows you to run docker-compose (which is still required) via Node.js. This is useful to bootstrap test environments.

This library supports docker-compose (v1 standalone) and as of this version docker compose (v2, the docker "compose" plugin).

Installation

yarn add --dev docker-compose

Documentation

The documentation can be found here.

Example

Import for docker-compose (v1)

To import commands for the v1 version, please use this import statement:

import * as compose from 'docker-compose'

You can also import only the required commands:

import { run, upAll } from 'docker-compose'

Import for docker compose (v2)

To import commands for the v2 version, please use this import statement:

import { v2 as compose } from 'docker-compose'

You can also import only the required commands:

import { run, upAll } from 'docker-compose/dist/v2'

Usage

To start service containers based on the docker-compose.yml file in your current directory, just call compose.upAll like this:

compose.upAll({ cwd: path.join(__dirname), log: true }).then(
  () => {
    console.log('done')
  },
  (err) => {
    console.log('something went wrong:', err.message)
  }
)

Start specific services using compose.upMany:

const services = ['serviceA', 'serviceB']
compose.upMany(services, { cwd: path.join(__dirname), log: true })

Or start a single service with compose.upOne:

const service = 'serviceA'
compose.upOne(service, { cwd: path.join(__dirname), log: true })

To execute command inside a running container

compose.exec('node', 'npm install', { cwd: path.join(__dirname) })

Known issues with v2 support

  • During testing we noticed that docker compose seems to send it's exit code also commands don't seem to have finished. This doesn't occur for all commands, but for example with stop or down. We had the option to wait for stopped / removed containers using third party libraries but this would make bootstrapping docker-compose much more complicated for the users. So we decided to use a setTimeout(500) workaround. We're aware this is not perfect but it seems to be the most appropriate solution for now. Details can be found in the v2 PR discussion (we're happy to get help here).

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 issue to introduce your idea and have a reference for your PR.

We're using conventional commits, 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 discussion.

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.

More Repositories

1

vite-react-typescript-tailwind-starter

Template for React + Tailwind CSS + TypeScript projects
TypeScript
62
star
2

http-problem-details

This library implements HTTP Problem details (RFC 7807) for HTTP APIs build with Node.js.
TypeScript
45
star
3

http-problem

Create problem+json documents with Node.js
JavaScript
22
star
4

express-http-problem-details

Express middleware to create HTTP Problem Details (RFC7807) by convention
TypeScript
16
star
5

http-problem-details-parser

Parse HTTP Problem Details (RFC7807) from objects / JSON to your local error types.
TypeScript
15
star
6

vscode-debug-es6-node-docker-sample

Sample showing how to debug an ES6 Node.js application inside Docker containers using Visual Studio Code
JavaScript
13
star
7

massive-migrate

Postgres migrations for Node.js based on Massive-js
JavaScript
9
star
8

http-problem-details-mapper

Map your Node.js errors to HTTP Problem details (RFC7807) by convention
TypeScript
9
star
9

AspNetRazorPagesTemplate

A GitHub template for ASP.NET Core (.NET 6) Razor Pages including TailwindCSS 3
CSS
8
star
10

aws-ebs-rex-ray-docker-compose

Sample how to use a AWS EBS volume with REX-Ray Docker plugin via Docker-Compose
7
star
11

AspNetCoreMvcHtmxTemplate

GitHub template for ASP.NET Core 6, HTMX and TailwindCSS
HTML
6
star
12

mongo-eventstore

A simple MongoDB event store
TypeScript
6
star
13

htmx-node-express-sample

A simple htmx.org sample with express
TypeScript
4
star
14

composefile

JavaScript
4
star
15

aspnetcore-on-minikube

Sample for ASP.NET Core on minikube
C#
3
star
16

massive-migrate-semver

Semantic versioning based migrations for Postgres based on Massive-Migrate
JavaScript
3
star
17

ts-node-prettier-vscode-starter

Node + TypeScript + Prettier + VS Code template for use with https://github.com/Rich-Harris/degit/
JavaScript
3
star
18

turborepo-node-react-tailwind-starter

Template to start a Node.js project with express, react, typescript and tailwind using turborepo
TypeScript
3
star
19

hapi-http-problem-details

Create HTTP Problem Details (RFC7807) for hapi application errors
TypeScript
3
star
20

tmux-cheatsheet

Yeat another cheat sheet for tmux, created from personal use.
2
star
21

aspnetcore-vite-react-template

ASP.NET Core + Vite + React Template
C#
2
star
22

aspnet-react-vite-tailwind

ASP.NET Core + React + vite + Tailwind CSS template
HTML
2
star
23

jenkins-node-docker-agent

Jenkins test agent Docker images for Node with Docker and Docker-Compose installed
Dockerfile
2
star
24

WebApiCorsSample

Sample for ASP.NET Web API 2 with CORS IIS Host and OWIN Self Host and JavaScript client
C#
2
star
25

aspnet-core-marten-htmx-vsa-template

C#
2
star
26

get-relative-whatwg-url

Get relative path of WHATWG URLs
JavaScript
2
star
27

migrate-semver

Database agnostic migrations based on SemVer using Node.js
JavaScript
1
star
28

migrate-semver-mongoose

JavaScript
1
star
29

net-retry-connect

Attempt to connect to net Sockets using retry patterns
JavaScript
1
star
30

WaitForPort.NET

Wait for Ports to be available using .NET
C#
1
star
31

acs-kubernetes-talk

Azure CLI + kubectl commands shown at k8s talk
1
star
32

ts-node-starter

Node + TypeScript template for use with https://github.com/Rich-Harris/degit/
1
star
33

WaitForPostgres.NET

Wait for Postgres connections using .NET
C#
1
star
34

vim-cheatsheet

Yet another vim cheatsheet, created from personal use.
1
star
35

aspnet-core-viewcomponents-sample

Sample Code
HTML
1
star
36

AspNetCoreMvcTemplate

A GitHub template for ASP.NET Core (.NET 6) MVC including TailwindCSS 3
CSS
1
star
37

DockerCompose.NET

Automate docker compose 2.x using .NET
C#
1
star
38

aspnet-core-htmx-vsa-template

Vertical Slice Architecture ASP.NET Core App template with Tailwind + HTMX
C#
1
star
39

express-http-warning

Create warnings following RFC draft-cedik-http-warning-02: https://tools.ietf.org/html/draft-cedik-http-warning-02
TypeScript
1
star
40

ts-schema-validator

Validate TypeScript objects based on their type definitions using your validation library of choice.
TypeScript
1
star