https://github.com/loong64/compose

https://github.com/docker/compose
https://github.com/loong64/compose

Last synced: about 2 months ago
JSON representation

https://github.com/docker/compose

• Host: GitHub
• URL: https://github.com/loong64/compose
• Owner: loong64
• License: apache-2.0
• Created: 2024-05-25T03:18:20.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T20:07:21.000Z (4 months ago)
• Last Synced: 2024-09-18T02:15:07.098Z (4 months ago)
• Language: Dockerfile
• Size: 8.79 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Table of Contents

- [Table of Contents](#table-of-contents)

- [Docker Compose v2](#docker-compose-v2)

- [Where to get Docker Compose](#where-to-get-docker-compose)

    - [Windows and macOS](#windows-and-macos)

    - [Linux](#linux)

  - [Quick Start](#quick-start)

  - [Contributing](#contributing)

  - [Legacy](#legacy)

# Docker Compose v2

[![GitHub release](https://img.shields.io/github/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest)

[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2)

[![Build Status](https://img.shields.io/github/actions/workflow/status/docker/compose/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci)

[![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2)

[![Codecov](https://codecov.io/gh/docker/compose/branch/main/graph/badge.svg?token=HP3K4Y4ctu)](https://codecov.io/gh/docker/compose)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/docker/compose/badge)](https://api.securityscorecards.dev/projects/github.com/docker/compose)

![Docker Compose](logo.png?raw=true "Docker Compose Logo")

Docker Compose is a tool for running multi-container applications on Docker

defined using the [Compose file format](https://compose-spec.io).

A Compose file is used to define how one or more containers that make up

your application are configured.

Once you have a Compose file, you can create and start your application with a

single command: `docker compose up`.

# Where to get Docker Compose

### Windows and macOS

Docker Compose is included in

[Docker Desktop](https://www.docker.com/products/docker-desktop)

for Windows and macOS.

### Linux

You can download Docker Compose binaries from the

[release page](https://github.com/docker/compose/releases) on this repository.

Rename the relevant binary for your OS to `docker-compose` and copy it to `$HOME/.docker/cli-plugins`

Or copy it into one of these folders to install it system-wide:

* `/usr/local/lib/docker/cli-plugins` OR `/usr/local/libexec/docker/cli-plugins`

* `/usr/lib/docker/cli-plugins` OR `/usr/libexec/docker/cli-plugins`

(might require making the downloaded file executable with `chmod +x`)

Quick Start

-----------

Using Docker Compose is a three-step process:

1. Define your app's environment with a `Dockerfile` so it can be

   reproduced anywhere.

2. Define the services that make up your app in `compose.yaml` so

   they can be run together in an isolated environment.

3. Lastly, run `docker compose up` and Compose will start and run your entire

   app.

A Compose file looks like this:

```yaml

services:

  web:

    build: .

    ports:

      - "5000:5000"

    volumes:

      - .:/code

  redis:

    image: redis

```

Contributing

------------

Want to help develop Docker Compose? Check out our

[contributing documentation](CONTRIBUTING.md).

If you find an issue, please report it on the

[issue tracker](https://github.com/docker/compose/issues/new/choose).

Legacy

-------------

The Python version of Compose is available under the `v1` [branch](https://github.com/docker/compose/tree/v1).