Skip to content

Commit c2f8036

Browse files
authored
Add "Open in Docker Dev Environments" links (docker#280)
* readme: add devenvs links in READMEs Signed-off-by: Nick Sieger <[email protected]>
1 parent d7f8184 commit c2f8036

File tree

25 files changed

+213
-267
lines changed

25 files changed

+213
-267
lines changed

README.md

Lines changed: 50 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
These samples provide a starting point for how to integrate different services using a Compose file and to manage their deployment with Docker Compose.
88

9-
> **Note**
9+
> **Note**
1010
> 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.
1111
1212
<!--lint disable awesome-toc-->
@@ -18,62 +18,66 @@ These samples provide a starting point for how to integrate different services u
1818

1919
## Samples of Docker Compose applications with multiple integrated services
2020

21-
<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/> Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/)
21+
<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.
2222

23-
- [`ASP.NET / MS-SQL`](https://github.com/docker/awesome-compose/tree/master/aspnet-mssql) - Sample ASP.NET core application
23+
- [`ASP.NET / MS-SQL`](aspnet-mssql) - Sample ASP.NET core application
2424
with MS SQL server database.
25-
- [`Elasticsearch / Logstash / Kibana`](https://github.com/docker/awesome-compose/tree/master/elasticsearch-logstash-kibana) - Sample Elasticsearch, Logstash, and Kibana stack.
26-
- [`Go / NGINX / MySQL`](https://github.com/docker/awesome-compose/tree/master/nginx-golang-mysql) - Sample Go application
27-
with an Nginx proxy and a MySQL database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
28-
- [`Go / NGINX / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/nginx-golang-postgres) - Sample Go
29-
application with an Nginx proxy and a PostgreSQL database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
30-
- [`Java Spark / MySQL`](https://github.com/docker/awesome-compose/tree/master/sparkjava-mysql) - Sample Java application and
31-
a MySQL database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
32-
- [`NGINX / ASP.NET / MySQL`](https://github.com/docker/awesome-compose/tree/master/nginx-aspnet-mysql) - Sample Nginx reverse proxy with an C# backend using ASP.NET&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
33-
- [`NGINX / Flask / MongoDB`](https://github.com/docker/awesome-compose/tree/master/nginx-flask-mongo) - Sample Python/Flask
34-
application with Nginx proxy and a Mongo database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
35-
- [`NGINX / Flask / MySQL`](https://github.com/docker/awesome-compose/tree/master/nginx-flask-mysql) - Sample Python/Flask application with an Nginx proxy and a MySQL database.
36-
- [`NGINX / Node.js / Redis`](https://github.com/docker/awesome-compose/tree/master/nginx-nodejs-redis) - Sample Node.js application with Nginx proxy and a Redis database
37-
- [`NGINX / Go`](https://github.com/docker/awesome-compose/tree/master/nginx-golang) - Sample Nginx proxy with a Go backend.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
38-
- [`NGINX / WSGI / Flask`](https://github.com/docker/awesome-compose/tree/master/nginx-wsgi-flask) - Sample Nginx reverse proxy with a Flask backend using WSGI.
39-
- [`PostgreSQL / pgAdmin`](https://github.com/docker/awesome-compose/tree/master/postgresql-pgadmin) - Sample setup for postgreSQL database with pgAdmin web interface
40-
- [`Python / Flask / Redis`](https://github.com/docker/awesome-compose/tree/master/flask-redis) - Sample Python/Flask and a Redis database&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
41-
- [`React / Spring / MySQL`](https://github.com/docker/awesome-compose/tree/master/react-java-mysql) - Sample React
42-
application with a Spring backend and a MySQL database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
43-
- [`React / Express / MySQL`](https://github.com/docker/awesome-compose/tree/master/react-express-mysql) - Sample React
44-
application with a Node.js backend and a MySQL database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
45-
- [`React / Express / MongoDB`](https://github.com/docker/awesome-compose/tree/master/react-express-mongodb) - Sample React
46-
application with a Node.js backend and a Mongo database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
47-
- [`React / Rust / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/react-rust-postgres) - Sample React
48-
application with a Rust backend and a Postgres database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
49-
- [`React / Nginx`](https://github.com/docker/awesome-compose/tree/master/react-nginx) - Sample React application with Nginx.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
50-
- [`Spring / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/spring-postgres) - Sample Java application
51-
with Spring framework and a Postgres database.&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
25+
- [`Elasticsearch / Logstash / Kibana`](elasticsearch-logstash-kibana) - Sample Elasticsearch, Logstash, and Kibana stack.
26+
- [`Go / NGINX / MySQL`](nginx-golang-mysql) - Sample Go application
27+
with an Nginx proxy and a MySQL database.&nbsp;<a href="nginx-golang-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
28+
- [`Go / NGINX / PostgreSQL`](nginx-golang-postgres) - Sample Go
29+
application with an Nginx proxy and a PostgreSQL database.&nbsp;<a href="nginx-golang-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
30+
- [`Java Spark / MySQL`](sparkjava-mysql) - Sample Java application and
31+
a MySQL database.&nbsp;<a href="sparkjava-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
32+
- [`NGINX / ASP.NET / MySQL`](nginx-aspnet-mysql) - Sample Nginx reverse proxy with an C# backend using ASP.NET&nbsp;<a href="nginx-aspnet-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
33+
- [`NGINX / Flask / MongoDB`](nginx-flask-mongo) - Sample Python/Flask
34+
application with Nginx proxy and a Mongo database.&nbsp;<a href="nginx-flask-mongo"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
35+
- [`NGINX / Flask / MySQL`](nginx-flask-mysql) - Sample Python/Flask application with an Nginx proxy and a MySQL database.
36+
- [`NGINX / Node.js / Redis`](nginx-nodejs-redis) - Sample Node.js application with Nginx proxy and a Redis database
37+
- [`NGINX / Go`](nginx-golang) - Sample Nginx proxy with a Go backend.&nbsp;<a href="nginx-golang"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
38+
- [`NGINX / WSGI / Flask`](nginx-wsgi-flask) - Sample Nginx reverse proxy with a Flask backend using WSGI.
39+
- [`PostgreSQL / pgAdmin`](postgresql-pgadmin) - Sample setup for postgreSQL database with pgAdmin web interface
40+
- [`Python / Flask / Redis`](flask-redis) - Sample Python/Flask and a Redis database&nbsp;<a href="flask-redis"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
41+
- [`React / Spring / MySQL`](react-java-mysql) - Sample React
42+
application with a Spring backend and a MySQL database.&nbsp;<a href="react-java-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
43+
- [`React / Express / MySQL`](react-express-mysql) - Sample React
44+
application with a Node.js backend and a MySQL database.&nbsp;<a href="react-express-mysql"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
45+
- [`React / Express / MongoDB`](react-express-mongodb) - Sample React
46+
application with a Node.js backend and a Mongo database.&nbsp;<a href="react-express-mongodb"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
47+
- [`React / Rust / PostgreSQL`](react-rust-postgres) - Sample React
48+
application with a Rust backend and a Postgres database.&nbsp;<a href="react-rust-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
49+
- [`React / Nginx`](react-nginx) - Sample React application with Nginx.&nbsp;<a href="react-nginx"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
50+
- [`Spring / PostgreSQL`](spring-postgres) - Sample Java application
51+
with Spring framework and a Postgres database.&nbsp;<a href="spring-postgres"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
52+
5253
## Single service samples
5354

54-
<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/> Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/)
55+
<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.
5556

56-
- [`Angular`](https://github.com/docker/awesome-compose/tree/master/angular)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
57-
- [`Spark`](https://github.com/docker/awesome-compose/tree/master/sparkjava)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
58-
- [`VueJS`](https://github.com/docker/awesome-compose/tree/master/vuejs)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
59-
- [`Flask`](https://github.com/docker/awesome-compose/tree/master/flask)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
60-
- [`PHP`](https://github.com/docker/awesome-compose/tree/master/apache-php)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
61-
- [`Traefik`](https://github.com/docker/awesome-compose/tree/master/traefik-golang)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
62-
- [`Django`](https://github.com/docker/awesome-compose/tree/master/django)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
57+
- [`Angular`](angular)&nbsp;<a href="angular"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
58+
- [`Spark`](sparkjava)&nbsp;<a href="sparkjava"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
59+
- [`VueJS`](vuejs)&nbsp;<a href="vuejs"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
60+
- [`Flask`](flask)&nbsp;<a href="flask"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
61+
- [`PHP`](apache-php)&nbsp;<a href="apache-php"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
62+
- [`Traefik`](traefik-golang)&nbsp;<a href="traefik-golang"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
63+
- [`Django`](django)&nbsp;<a href="django"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
6364
- [`Minecraft server`](https://github.com/docker/awesome-compose/tree/master/minecraft)
6465
- [`Plex`](https://github.com/docker/awesome-compose/tree/master/plex)
6566
- [`Portainer`](https://github.com/docker/awesome-compose/tree/master/portainer)
6667
- [`Wireguard`](https://github.com/docker/awesome-compose/tree/master/wireguard)
67-
- [`FastAPI`](https://github.com/docker/awesome-compose/tree/master/fastapi)&nbsp;<img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/>
68-
## Basic setups for different platforms (not production ready - useful for personal use)
69-
- [`Gitea / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/gitea-postgres)
70-
- [`Nextcloud / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/nextcloud-postgres)
71-
- [`Nextcloud / Redis / MariaDB`](https://github.com/docker/awesome-compose/tree/master/nextcloud-redis-mariadb)
72-
- [`Pi-hole / cloudflared`](https://github.com/docker/awesome-compose/tree/master/pihole-cloudflared-DoH) - Sample Pi-hole setup with use of DoH cloudflared service
73-
- [`Prometheus / Grafana`](https://github.com/docker/awesome-compose/tree/master/prometheus-grafana)
74-
- [`Wordpress / MySQL`](https://github.com/docker/awesome-compose/tree/master/wordpress-mysql)
68+
- [`FastAPI`](fastapi)&nbsp;<a href="fastapi#use-with-docker-development-environments"><img src="icon_devenvs.svg" alt="Use with Docker Dev Environments" height="30" align="top"/></a>
69+
70+
## Basic setups for different platforms (not production ready - useful for personal use)
71+
72+
- [`Gitea / PostgreSQL`](gitea-postgres)
73+
- [`Nextcloud / PostgreSQL`](nextcloud-postgres)
74+
- [`Nextcloud / Redis / MariaDB`](nextcloud-redis-mariadb)
75+
- [`Pi-hole / cloudflared`](pihole-cloudflared-DoH) - Sample Pi-hole setup with use of DoH cloudflared service
76+
- [`Prometheus / Grafana`](prometheus-grafana)
77+
- [`Wordpress / MySQL`](wordpress-mysql)
7578

7679
<!--lint disable awesome-toc-->
80+
7781
## Getting started
7882

7983
These instructions will get you through the bootstrap phase of creating and

angular/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Compose sample
2+
3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/angular)
8+
29
### Angular service
310

411
Project structure:
@@ -65,14 +72,3 @@ Stop and remove the container
6572
```
6673
$ docker compose down
6774
```
68-
69-
## Use with Docker Development Environments
70-
71-
You can use this sample with the Dev Environments feature of Docker Desktop.
72-
73-
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)
74-
75-
To develop directly on the services inside containers, use the HTTPS Git url of the sample:
76-
```
77-
https://github.com/docker/awesome-compose/tree/master/angular
78-
```

apache-php/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Compose sample application
2+
3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/apache-php)
8+
29
### PHP application with Apache2
310

411
Project structure:
@@ -54,14 +61,3 @@ Stop and remove the containers
5461
```
5562
$ docker compose down
5663
```
57-
58-
## Use with Docker Development Environments
59-
60-
You can use this sample with the Dev Environments feature of Docker Desktop.
61-
62-
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)
63-
64-
To develop directly on the services inside containers, use the HTTPS Git url of the sample:
65-
```
66-
https://github.com/docker/awesome-compose/tree/master/apache-php
67-
```

dev-envs.png

-158 KB
Binary file not shown.

django/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Compose sample application
2+
3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/django)
8+
29
### Django application in dev mode
310

411
Project structure:
@@ -50,10 +57,3 @@ Stop and remove the containers
5057
```
5158
$ docker compose down
5259
```
53-
## Use with Docker Development Environments
54-
55-
You can use this sample with the Dev Environments feature of Docker Desktop.
56-
To develop directly the web service inside a container, you just need to use the https git url of the sample:
57-
`https://github.com/docker/awesome-compose/tree/master/django`
58-
59-
![page](../dev-envs.png)

fastapi/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Compose sample application
2+
3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/fastapi)
8+
29
### Python/FastAPI application
310

411
Project structure:
@@ -51,14 +58,3 @@ Stop and remove the containers
5158
```
5259
$ docker compose down
5360
```
54-
55-
## Use with Docker Development Environments
56-
57-
You can use this sample with the Dev Environments feature of Docker Desktop.
58-
59-
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)
60-
61-
To develop directly on the services inside containers, use the HTTPS Git url of the sample:
62-
```
63-
https://github.com/docker/awesome-compose/tree/master/fastapi
64-
```

flask-redis/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
## Compose sample application
22

3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/flask-redis)
8+
39
### Python/Flask application using a Redis database
410

511
Project structure:
@@ -80,14 +86,3 @@ Stop and remove the containers
8086
```
8187
$ docker compose down
8288
```
83-
84-
## Use with Docker Development Environments
85-
86-
You can use this sample with the Dev Environments feature of Docker Desktop.
87-
88-
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)
89-
90-
To develop directly on the services inside containers, use the HTTPS Git url of the sample:
91-
```
92-
https://github.com/docker/awesome-compose/tree/master/flask-redis
93-
```

flask/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
## Compose sample application
2+
3+
### Use with Docker Development Environments
4+
5+
You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later.
6+
7+
[Open in Docker Dev Environments <img src="../open_in_new.svg" alt="Open in Docker Dev Environments" align="top"/>](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/flask)
8+
29
### Python/Flask application
310

411
Project structure:
@@ -55,14 +62,3 @@ Stop and remove the containers
5562
```
5663
$ docker compose down
5764
```
58-
59-
## Use with Docker Development Environments
60-
61-
You can use this sample with the Dev Environments feature of Docker Desktop.
62-
63-
![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png)
64-
65-
To develop directly on the services inside containers, use the HTTPS Git url of the sample:
66-
```
67-
https://github.com/docker/awesome-compose/tree/master/flask
68-
```

0 commit comments

Comments
 (0)