diff --git a/README.md b/README.md index af8e5a8ac..484e2badd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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** +> **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. @@ -18,62 +18,66 @@ These samples provide a starting point for how to integrate different services u ## Samples of Docker Compose applications with multiple integrated services -Use with Docker Dev Environments Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/) +Use with Docker Dev Environments 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`](https://github.com/docker/awesome-compose/tree/master/aspnet-mssql) - Sample ASP.NET core application +- [`ASP.NET / MS-SQL`](aspnet-mssql) - Sample ASP.NET core application with MS SQL server database. -- [`Elasticsearch / Logstash / Kibana`](https://github.com/docker/awesome-compose/tree/master/elasticsearch-logstash-kibana) - Sample Elasticsearch, Logstash, and Kibana stack. -- [`Go / NGINX / MySQL`](https://github.com/docker/awesome-compose/tree/master/nginx-golang-mysql) - Sample Go application -with an Nginx proxy and a MySQL database. Use with Docker Dev Environments -- [`Go / NGINX / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/nginx-golang-postgres) - Sample Go -application with an Nginx proxy and a PostgreSQL database. Use with Docker Dev Environments -- [`Java Spark / MySQL`](https://github.com/docker/awesome-compose/tree/master/sparkjava-mysql) - Sample Java application and -a MySQL database. Use with Docker Dev Environments -- [`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 Use with Docker Dev Environments -- [`NGINX / Flask / MongoDB`](https://github.com/docker/awesome-compose/tree/master/nginx-flask-mongo) - Sample Python/Flask -application with Nginx proxy and a Mongo database. Use with Docker Dev Environments -- [`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. -- [`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 -- [`NGINX / Go`](https://github.com/docker/awesome-compose/tree/master/nginx-golang) - Sample Nginx proxy with a Go backend. Use with Docker Dev Environments -- [`NGINX / WSGI / Flask`](https://github.com/docker/awesome-compose/tree/master/nginx-wsgi-flask) - Sample Nginx reverse proxy with a Flask backend using WSGI. -- [`PostgreSQL / pgAdmin`](https://github.com/docker/awesome-compose/tree/master/postgresql-pgadmin) - Sample setup for postgreSQL database with pgAdmin web interface -- [`Python / Flask / Redis`](https://github.com/docker/awesome-compose/tree/master/flask-redis) - Sample Python/Flask and a Redis database Use with Docker Dev Environments -- [`React / Spring / MySQL`](https://github.com/docker/awesome-compose/tree/master/react-java-mysql) - Sample React -application with a Spring backend and a MySQL database. Use with Docker Dev Environments -- [`React / Express / MySQL`](https://github.com/docker/awesome-compose/tree/master/react-express-mysql) - Sample React -application with a Node.js backend and a MySQL database. Use with Docker Dev Environments -- [`React / Express / MongoDB`](https://github.com/docker/awesome-compose/tree/master/react-express-mongodb) - Sample React -application with a Node.js backend and a Mongo database. Use with Docker Dev Environments -- [`React / Rust / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/react-rust-postgres) - Sample React -application with a Rust backend and a Postgres database. Use with Docker Dev Environments -- [`React / Nginx`](https://github.com/docker/awesome-compose/tree/master/react-nginx) - Sample React application with Nginx. Use with Docker Dev Environments -- [`Spring / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/spring-postgres) - Sample Java application -with Spring framework and a Postgres database. Use with Docker Dev Environments +- [`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. Use with Docker Dev Environments +- [`Go / NGINX / PostgreSQL`](nginx-golang-postgres) - Sample Go +application with an Nginx proxy and a PostgreSQL database. Use with Docker Dev Environments +- [`Java Spark / MySQL`](sparkjava-mysql) - Sample Java application and +a MySQL database. Use with Docker Dev Environments +- [`NGINX / ASP.NET / MySQL`](nginx-aspnet-mysql) - Sample Nginx reverse proxy with an C# backend using ASP.NET Use with Docker Dev Environments +- [`NGINX / Flask / MongoDB`](nginx-flask-mongo) - Sample Python/Flask +application with Nginx proxy and a Mongo database. Use with Docker Dev Environments +- [`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. Use with Docker Dev Environments +- [`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 Use with Docker Dev Environments +- [`React / Spring / MySQL`](react-java-mysql) - Sample React +application with a Spring backend and a MySQL database. Use with Docker Dev Environments +- [`React / Express / MySQL`](react-express-mysql) - Sample React +application with a Node.js backend and a MySQL database. Use with Docker Dev Environments +- [`React / Express / MongoDB`](react-express-mongodb) - Sample React +application with a Node.js backend and a Mongo database. Use with Docker Dev Environments +- [`React / Rust / PostgreSQL`](react-rust-postgres) - Sample React +application with a Rust backend and a Postgres database. Use with Docker Dev Environments +- [`React / Nginx`](react-nginx) - Sample React application with Nginx. Use with Docker Dev Environments +- [`Spring / PostgreSQL`](spring-postgres) - Sample Java application +with Spring framework and a Postgres database. Use with Docker Dev Environments + ## Single service samples -Use with Docker Dev Environments Icon indicates Sample is compatible with [Docker Dev Environments](https://docs.docker.com/desktop/dev-environments/) +Use with Docker Dev Environments 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`](https://github.com/docker/awesome-compose/tree/master/angular) Use with Docker Dev Environments -- [`Spark`](https://github.com/docker/awesome-compose/tree/master/sparkjava) Use with Docker Dev Environments -- [`VueJS`](https://github.com/docker/awesome-compose/tree/master/vuejs) Use with Docker Dev Environments -- [`Flask`](https://github.com/docker/awesome-compose/tree/master/flask) Use with Docker Dev Environments -- [`PHP`](https://github.com/docker/awesome-compose/tree/master/apache-php) Use with Docker Dev Environments -- [`Traefik`](https://github.com/docker/awesome-compose/tree/master/traefik-golang) Use with Docker Dev Environments -- [`Django`](https://github.com/docker/awesome-compose/tree/master/django) Use with Docker Dev Environments +- [`Angular`](angular) Use with Docker Dev Environments +- [`Spark`](sparkjava) Use with Docker Dev Environments +- [`VueJS`](vuejs) Use with Docker Dev Environments +- [`Flask`](flask) Use with Docker Dev Environments +- [`PHP`](apache-php) Use with Docker Dev Environments +- [`Traefik`](traefik-golang) Use with Docker Dev Environments +- [`Django`](django) Use with Docker Dev Environments - [`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`](https://github.com/docker/awesome-compose/tree/master/fastapi) Use with Docker Dev Environments -## Basic setups for different platforms (not production ready - useful for personal use) -- [`Gitea / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/gitea-postgres) -- [`Nextcloud / PostgreSQL`](https://github.com/docker/awesome-compose/tree/master/nextcloud-postgres) -- [`Nextcloud / Redis / MariaDB`](https://github.com/docker/awesome-compose/tree/master/nextcloud-redis-mariadb) -- [`Pi-hole / cloudflared`](https://github.com/docker/awesome-compose/tree/master/pihole-cloudflared-DoH) - Sample Pi-hole setup with use of DoH cloudflared service -- [`Prometheus / Grafana`](https://github.com/docker/awesome-compose/tree/master/prometheus-grafana) -- [`Wordpress / MySQL`](https://github.com/docker/awesome-compose/tree/master/wordpress-mysql) +- [`FastAPI`](fastapi) Use with Docker Dev Environments + +## 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) + ## Getting started These instructions will get you through the bootstrap phase of creating and diff --git a/angular/README.md b/angular/README.md index b0a05a368..6d164a64a 100644 --- a/angular/README.md +++ b/angular/README.md @@ -1,4 +1,11 @@ ## Compose sample + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/angular) + ### Angular service Project structure: @@ -65,14 +72,3 @@ Stop and remove the container ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/angular -``` diff --git a/apache-php/README.md b/apache-php/README.md index 908faf4da..7179b8faa 100644 --- a/apache-php/README.md +++ b/apache-php/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/apache-php) + ### PHP application with Apache2 Project structure: @@ -54,14 +61,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/apache-php -``` diff --git a/dev-envs.png b/dev-envs.png deleted file mode 100644 index b318c78ff..000000000 Binary files a/dev-envs.png and /dev/null differ diff --git a/django/README.md b/django/README.md index 16a5cc3b1..53c97f5c9 100644 --- a/django/README.md +++ b/django/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/django) + ### Django application in dev mode Project structure: @@ -50,10 +57,3 @@ Stop and remove the containers ``` $ docker compose down ``` -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly the web service inside a container, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/django` - -![page](../dev-envs.png) \ No newline at end of file diff --git a/fastapi/README.md b/fastapi/README.md index 4d20eea4b..13434de0a 100644 --- a/fastapi/README.md +++ b/fastapi/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/fastapi) + ### Python/FastAPI application Project structure: @@ -51,14 +58,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/fastapi -``` diff --git a/flask-redis/README.md b/flask-redis/README.md index 01e3256d3..f9dfd037f 100644 --- a/flask-redis/README.md +++ b/flask-redis/README.md @@ -1,5 +1,11 @@ ## Compose sample application +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/flask-redis) + ### Python/Flask application using a Redis database Project structure: @@ -80,14 +86,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/flask-redis -``` diff --git a/flask/README.md b/flask/README.md index 36e78d59c..c8b0efd36 100644 --- a/flask/README.md +++ b/flask/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/flask) + ### Python/Flask application Project structure: @@ -55,14 +62,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/flask -``` diff --git a/nginx-aspnet-mysql/README.md b/nginx-aspnet-mysql/README.md index 503eda97e..e18863c3b 100644 --- a/nginx-aspnet-mysql/README.md +++ b/nginx-aspnet-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-aspnet-mysql) + ### ASP.NET server with an Nginx proxy and a MySQL database Project structure: @@ -75,14 +82,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-aspnet-mysql -``` diff --git a/nginx-flask-mongo/README.md b/nginx-flask-mongo/README.md index 5838d8046..97fa9ff01 100644 --- a/nginx-flask-mongo/README.md +++ b/nginx-flask-mongo/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-flask-mongo) + ### Python/Flask application with Nginx proxy and a Mongo database Project structure: @@ -69,14 +76,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-flask-mongo -``` diff --git a/nginx-flask-mysql/README.md b/nginx-flask-mysql/README.md index 2d21a39b1..291612ce5 100644 --- a/nginx-flask-mysql/README.md +++ b/nginx-flask-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-flask-mysql) + ### Python/Flask with Nginx proxy and MySQL database Project structure: @@ -77,14 +84,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-flask-mysql -``` diff --git a/nginx-golang-mysql/README.md b/nginx-golang-mysql/README.md index 16c403b3b..1696a85bd 100644 --- a/nginx-golang-mysql/README.md +++ b/nginx-golang-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-golang-mysql) + ### Go server with an Nginx proxy and a MariaDB/MySQL database Project structure: @@ -90,14 +97,3 @@ Stop and remove the containers ```shell $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-golang-mysql -``` diff --git a/nginx-golang-postgres/README.md b/nginx-golang-postgres/README.md index 87170bc84..1671ec8a0 100644 --- a/nginx-golang-postgres/README.md +++ b/nginx-golang-postgres/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-golang-postgres) + ### Go server with an Nginx proxy and a Postgres database Project structure: @@ -80,14 +87,3 @@ Stop and remove the containers ```shell $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-golang-postgres -``` diff --git a/nginx-golang/README.md b/nginx-golang/README.md index b4d085324..506626b77 100644 --- a/nginx-golang/README.md +++ b/nginx-golang/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/nginx-golang) + ### NGINX proxy with Go backend Project structure: @@ -83,14 +90,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/nginx-golang -``` diff --git a/open_in_new.svg b/open_in_new.svg new file mode 100644 index 000000000..112ff73b6 --- /dev/null +++ b/open_in_new.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/react-express-mongodb/README.md b/react-express-mongodb/README.md index 2f896e7e7..69873cc70 100644 --- a/react-express-mongodb/README.md +++ b/react-express-mongodb/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/react-express-mongodb) + ### React application with a NodeJS backend and a MongoDB database Project structure: @@ -132,14 +139,3 @@ __Explanation of service mongo__ :key: `If you wish to check your DB changes on your local machine as well. You should have installed MongoDB locally, otherwise you can't access your mongodb service of container from host machine.` :white_check_mark: You should check your __mongo__ version is same as used in image. You can see the version of __mongo__ image in `docker-compose `file, I used __image: mongo:4.2.0__. If your mongo db version on your machine is not same then furst you have to updated your local __mongo__ version in order to works correctly. - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/react-express-mongodb -``` diff --git a/react-express-mysql/README.md b/react-express-mysql/README.md index 2f87ab273..46c4e4c45 100644 --- a/react-express-mysql/README.md +++ b/react-express-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/react-express-mysql) + ### React application with a NodeJS backend and a MySQL database Project structure: @@ -97,14 +104,3 @@ Removing react-express-mysql_db_1 ... done Removing network react-express-mysql_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/react-express-mysql -``` diff --git a/react-java-mysql/README.md b/react-java-mysql/README.md index 741166a2a..1259f24d9 100644 --- a/react-java-mysql/README.md +++ b/react-java-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/react-java-mysql) + ### React application with a Spring backend and a MySQL database Project structure: @@ -35,12 +42,12 @@ services: ... ``` The compose file defines an application with three services `frontend`, `backend` and `db`. -When deploying the application, docker compose maps port 3000 of the frontend service container to port 3000 of the host as specified in the file. +When deploying the application, docker compose maps port 3000 of the frontend service container to port 3000 of the host as specified in the file. Make sure port 3000 on the host is not already being in use. -> ℹ️ **_INFO_** -> For compatibility purpose between `AMD64` and `ARM64` architecture, we use a MariaDB as database instead of MySQL. -> You still can use the MySQL image by uncommenting the following line in the Compose file +> ℹ️ **_INFO_** +> For compatibility purpose between `AMD64` and `ARM64` architecture, we use a MariaDB as database instead of MySQL. +> You still can use the MySQL image by uncommenting the following line in the Compose file > `#image: mysql:8.0.27` ## Deploy with docker compose @@ -83,11 +90,3 @@ Removing react-java-mysql_frontend_1 ... done Removing react-java-mysql_db_1 ... done Removing network react-java-mysql_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly frontend or the backend services inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/react-java-mysql` - -![page](../dev-envs.png) \ No newline at end of file diff --git a/react-nginx/README.md b/react-nginx/README.md index 784687d28..7b7044a43 100755 --- a/react-nginx/README.md +++ b/react-nginx/README.md @@ -1,5 +1,11 @@ ## Compose sample application +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/react-nginx) + ### An project deploy React Application with Nginx Project structure: @@ -86,14 +92,3 @@ Stopping frontend ... done Removing frontend ... done Removing network react-nginx_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. - -![Screenshot of creating a Dev Environment in Docker Desktop](../dev-envs.png) - -To develop directly on the services inside containers, use the HTTPS Git url of the sample: -``` -https://github.com/docker/awesome-compose/tree/master/react-nginx -``` \ No newline at end of file diff --git a/react-rust-postgres/readme.md b/react-rust-postgres/readme.md index de6368504..298de803a 100644 --- a/react-rust-postgres/readme.md +++ b/react-rust-postgres/readme.md @@ -1,5 +1,11 @@ ## Compose sample application +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/react-rust-postgres) + ### React application with a Rust backend and a Postgresql database Project structure: @@ -74,11 +80,3 @@ Removing react-rust-postgres_frontend_1 ... done Removing react-rust-postgres_db_1 ... done Removing network react-rust-postgres_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly frontend or the backend services inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/react-rust-postgres` - -![page](../dev-envs.png) diff --git a/sparkjava-mysql/README.md b/sparkjava-mysql/README.md index 195704979..893ea3e9d 100644 --- a/sparkjava-mysql/README.md +++ b/sparkjava-mysql/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/sparkjava-mysql) + ### Java Spark application with MySQL database Project structure: @@ -75,11 +82,3 @@ Removing sparkjava-mysql_backend_1 ... done Removing sparkjava-mysql_db_1 ... done Removing network sparkjava-mysql_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly frontend or the backend services inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/sparkjava-mysql` - -![page](../dev-envs.png) \ No newline at end of file diff --git a/sparkjava/README.md b/sparkjava/README.md index a448233aa..83d9223d4 100644 --- a/sparkjava/README.md +++ b/sparkjava/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/sparkjava) + ### Spark Java Project structure: @@ -59,11 +66,3 @@ Stopping sparkjava_sparkjava_1 ... done Removing sparkjava_sparkjava_1 ... done Removing network sparkjava_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly sparkjava service inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/sparkjava` - -![page](../dev-envs.png) diff --git a/spring-postgres/README.md b/spring-postgres/README.md index e5b47d1ab..ca4e9cb48 100644 --- a/spring-postgres/README.md +++ b/spring-postgres/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/spring-postgres) + ### Java application with Spring framework and a Postgres database Project structure: @@ -77,11 +84,3 @@ Removing spring-postgres_db_1 ... done Removing spring-postgres_backend_1 ... done Removing network spring-postgres_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly frontend or the backend services inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/spring-postgres` - -![page](../dev-envs.png) diff --git a/traefik-golang/README.md b/traefik-golang/README.md index 55f20d1bc..7a86e7599 100644 --- a/traefik-golang/README.md +++ b/traefik-golang/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/traefik-golang) + ### TRAEFIK proxy with GO backend Project structure: @@ -92,11 +99,3 @@ Stop and remove the containers ``` $ docker compose down ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly the backend service inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/traefik-golang` - -![page](../dev-envs.png) diff --git a/vuejs/README.md b/vuejs/README.md index fc4782e67..1fd4d1dfc 100644 --- a/vuejs/README.md +++ b/vuejs/README.md @@ -1,4 +1,11 @@ ## Compose sample application + +### Use with Docker Development Environments + +You can open this sample in the Dev Environments feature of Docker Desktop version 4.12 or later. + +[Open in Docker Dev Environments Open in Docker Dev Environments](https://open.docker.com/dashboard/dev-envs?url=https://github.com/docker/awesome-compose/tree/master/vuejs) + ### VueJS Project structure: @@ -59,11 +66,3 @@ Stopping vuejs_web_1 ... done Removing vuejs_web_1 ... done Removing network vuejs_default ``` - -## Use with Docker Development Environments - -You can use this sample with the Dev Environments feature of Docker Desktop. -To develop directly web service inside containers, you just need to use the https git url of the sample: -`https://github.com/docker/awesome-compose/tree/master/vuejs` - -![page](../dev-envs.png)