e3ea3e9044
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com> Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
122 lines
8.8 KiB
Markdown
122 lines
8.8 KiB
Markdown
# Awesome Compose [](https://awesome.re)
|
|
|
|
|
|
|
|
> 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.
|
|
|
|
<!--lint disable awesome-toc-->
|
|
## Contents
|
|
|
|
- [Samples of Docker Compose applications with multiple integrated services](#samples-of-docker-compose-applications-with-multiple-integrated-services).
|
|
- [Single service samples](#single-service-samples).
|
|
- [Basic setups for different platforms (not production ready - useful for personal use)](#basic-setups-for-different-platforms-not-production-ready---useful-for-personal-use).
|
|
|
|
## Samples of Docker Compose applications with multiple integrated services
|
|
|
|
<a href="https://docs.docker.com/desktop/dev-environments/"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a> Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/) in Docker Desktop version 4.10 or later.
|
|
|
|
- [`ASP.NET / MS-SQL`](aspnet-mssql) - Sample ASP.NET core application
|
|
with MS SQL server database.
|
|
- [`Elasticsearch / Logstash / Kibana`](elasticsearch-logstash-kibana) - Sample Elasticsearch, Logstash, and Kibana stack.
|
|
- [`Go / NGINX / MySQL`](nginx-golang-mysql) - Sample Go application
|
|
with an Nginx proxy and a MySQL database. <a href="nginx-golang-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Go / NGINX / PostgreSQL`](nginx-golang-postgres) - Sample Go
|
|
application with an Nginx proxy and a PostgreSQL database. <a href="nginx-golang-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Java Spark / MySQL`](sparkjava-mysql) - Sample Java application and
|
|
a MySQL database. <a href="sparkjava-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`NGINX / ASP.NET / MySQL`](nginx-aspnet-mysql) - Sample Nginx reverse proxy with an C# backend using ASP.NET <a href="nginx-aspnet-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`NGINX / Flask / MongoDB`](nginx-flask-mongo) - Sample Python/Flask
|
|
application with Nginx proxy and a Mongo database. <a href="nginx-flask-mongo"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`NGINX / Flask / MySQL`](nginx-flask-mysql) - Sample Python/Flask application with an Nginx proxy and a MySQL database.
|
|
- [`NGINX / Node.js / Redis`](nginx-nodejs-redis) - Sample Node.js application with Nginx proxy and a Redis database
|
|
- [`NGINX / Go`](nginx-golang) - Sample Nginx proxy with a Go backend. <a href="nginx-golang"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`NGINX / WSGI / Flask`](nginx-wsgi-flask) - Sample Nginx reverse proxy with a Flask backend using WSGI.
|
|
- [`PostgreSQL / pgAdmin`](postgresql-pgadmin) - Sample setup for postgreSQL database with pgAdmin web interface
|
|
- [`Python / Flask / Redis`](flask-redis) - Sample Python/Flask and a Redis database <a href="flask-redis"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`React / Spring / MySQL`](react-java-mysql) - Sample React
|
|
application with a Spring backend and a MySQL database. <a href="react-java-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`React / Express / MySQL`](react-express-mysql) - Sample React
|
|
application with a Node.js backend and a MySQL database. <a href="react-express-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`React / Express / MongoDB`](react-express-mongodb) - Sample React
|
|
application with a Node.js backend and a Mongo database. <a href="react-express-mongodb"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`React / Rust / PostgreSQL`](react-rust-postgres) - Sample React
|
|
application with a Rust backend and a Postgres database. <a href="react-rust-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`React / Nginx`](react-nginx) - Sample React application with Nginx. <a href="react-nginx"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Spring / PostgreSQL`](spring-postgres) - Sample Java application
|
|
with Spring framework and a Postgres database. <a href="spring-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
|
|
## Single service samples
|
|
|
|
<a href="https://docs.docker.com/desktop/dev-environments/"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a> Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/) in Docker Desktop version 4.10 or later.
|
|
|
|
- [`Angular`](angular) <a href="angular"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Spark`](sparkjava) <a href="sparkjava"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`VueJS`](vuejs) <a href="vuejs"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Flask`](flask) <a href="flask"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`PHP`](apache-php) <a href="apache-php"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Traefik`](traefik-golang) <a href="traefik-golang"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Django`](django) <a href="django"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
- [`Minecraft server`](https://github.com/docker/awesome-compose/tree/master/minecraft)
|
|
- [`Plex`](https://github.com/docker/awesome-compose/tree/master/plex)
|
|
- [`Portainer`](https://github.com/docker/awesome-compose/tree/master/portainer)
|
|
- [`Wireguard`](https://github.com/docker/awesome-compose/tree/master/wireguard)
|
|
- [`FastAPI`](fastapi) <a href="fastapi#use-with-docker-development-environments"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
|
|
|
|
## Basic setups for different platforms (not production ready - useful for personal use)
|
|
|
|
- [`Gitea / PostgreSQL`](gitea-postgres)
|
|
- [`Nextcloud / PostgreSQL`](nextcloud-postgres)
|
|
- [`Nextcloud / Redis / MariaDB`](nextcloud-redis-mariadb)
|
|
- [`Pi-hole / cloudflared`](pihole-cloudflared-DoH) - Sample Pi-hole setup with use of DoH cloudflared service
|
|
- [`Prometheus / Grafana`](prometheus-grafana)
|
|
- [`Wordpress / MySQL`](wordpress-mysql)
|
|
|
|
<!--lint disable awesome-toc-->
|
|
|
|
## Getting started
|
|
|
|
These instructions will get you through the bootstrap phase of creating and
|
|
deploying samples of containerized applications with Docker Compose.
|
|
|
|
### Prerequisites
|
|
|
|
- Make sure that you have Docker and Docker Compose installed
|
|
- Windows or macOS:
|
|
[Install Docker Desktop](https://www.docker.com/get-started)
|
|
- Linux: [Install Docker](https://www.docker.com/get-started) and then
|
|
[Docker Compose](https://github.com/docker/compose)
|
|
- Download some or all of the samples from this repository.
|
|
|
|
### 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:
|
|
|
|
```console
|
|
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:
|
|
|
|
```console
|
|
docker compose down
|
|
```
|
|
|
|
### Quickstart guides
|
|
|
|
In addition to all the ready to run Compose samples listed above the folder [official-documentation-samples](official-documentation-samples/README.md) 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.
|
|
|
|
<!--lint disable awesome-toc-->
|
|
## Contribute
|
|
|
|
We welcome examples that help people understand how to use Docker Compose for
|
|
common applications. Check the [Contribution Guide](CONTRIBUTING.md) for more details.
|