awesome-compose/README.md

9.1 KiB

Awesome Compose Awesome

logo

A curated list of Docker Compose samples.

These samples provide a starting point for how to integrate different services using a Compose file and to manage their deployment with Docker Compose.

Note

The following samples are intended for use in local development environments such as project setups, tinkering with software stacks, etc. These samples must not be deployed in production environments.

Contents

Samples of Docker Compose applications with multiple integrated services

Use with Docker Dev Environments Icon indicates Sample is compatible with Docker Dev Environments in Docker Desktop version 4.10 or later.

Single service samples

Use with Docker Dev Environments Icon indicates Sample is compatible with Docker Dev Environments in Docker Desktop version 4.10 or later.

Basic setups for different platforms (not production ready - useful for personal use)

Getting started

These instructions will get you through the bootstrap phase of creating and deploying samples of containerized applications with Docker Compose.

Prerequisites

Running a sample

The root directory of each sample contains the compose.yaml which describes the configuration of service components. All samples can be run in a local environment by going into the root directory of each one and executing:

docker compose up -d

Check the README.md of each sample to get more details on the structure and what is the expected output. To stop and remove all containers of the sample application run:

docker compose down

Quickstart guides

In addition to all the ready to run Compose samples listed above the folder official-documentation-samples contains quickstart guides. Each of these step by step guides explain which files need to be created to build and run a Docker Compose application.

Contribute

We welcome examples that help people understand how to use Docker Compose for common applications. Check the Contribution Guide for more details.