From 9d8f8a896bedd7ee9148cc4508714f86d9c23b86 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Tue, 12 Nov 2024 13:57:59 -0500 Subject: [PATCH 1/3] Adding note about alternate use of docker-compose --- sample/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sample/README.md b/sample/README.md index 6b0109aa263..7bab6b63503 100644 --- a/sample/README.md +++ b/sample/README.md @@ -7,6 +7,11 @@ The Sample describes several demos of quickly spinning up different Prebid Serve In the Sample, we use `docker` and `docker-compose` to instantiate examples; with docker providing a unified setup and interface, you can spin up a demo server instance locally with only one command without knowing all the complexities. The docker image used in `docker-compose.yml` is the `Dockerfile` residing in the root level of the repository. + +> [!NOTE] +> Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated. If you receive an error when trying to run `docker-compose`, use `docker compose` (without the dash) instead. + + ## Option 1 - Standard Docker Engine Install `docker` and `docker-compose` via the [official docker page](https://docs.docker.com/compose/install/#scenario-one-install-docker-desktop). If you cannot use the official docker engine due to restrictions of its license, see the option below about using Podman instead of Docker. From 627ae06147be32ebcee5b9ddb93305b0055b053f Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Tue, 12 Nov 2024 14:21:59 -0500 Subject: [PATCH 2/3] Removing extra lines --- sample/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/sample/README.md b/sample/README.md index 7bab6b63503..aa95f589e54 100644 --- a/sample/README.md +++ b/sample/README.md @@ -7,11 +7,9 @@ The Sample describes several demos of quickly spinning up different Prebid Serve In the Sample, we use `docker` and `docker-compose` to instantiate examples; with docker providing a unified setup and interface, you can spin up a demo server instance locally with only one command without knowing all the complexities. The docker image used in `docker-compose.yml` is the `Dockerfile` residing in the root level of the repository. - > [!NOTE] > Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated. If you receive an error when trying to run `docker-compose`, use `docker compose` (without the dash) instead. - ## Option 1 - Standard Docker Engine Install `docker` and `docker-compose` via the [official docker page](https://docs.docker.com/compose/install/#scenario-one-install-docker-desktop). If you cannot use the official docker engine due to restrictions of its license, see the option below about using Podman instead of Docker. From b1473cb44444575c6ae12235b437614e9def7935 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney Date: Mon, 27 Jan 2025 01:03:16 -0500 Subject: [PATCH 3/3] Implementing suggestions from PR feedback --- sample/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/sample/README.md b/sample/README.md index aa95f589e54..c16beb856af 100644 --- a/sample/README.md +++ b/sample/README.md @@ -8,7 +8,12 @@ In the Sample, we use `docker` and `docker-compose` to instantiate examples; wit The docker image used in `docker-compose.yml` is the `Dockerfile` residing in the root level of the repository. > [!NOTE] -> Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated. If you receive an error when trying to run `docker-compose`, use `docker compose` (without the dash) instead. +> Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated. +> +> - Run `docker-compose` for docker compose version 1.X. +> - Run `docker compose` (without the dash) for docker compose versions 2.X and 3.X. +> +> For more details please refer to the [History and development of Docker compose](https://docs.docker.com/compose/intro/history/). ## Option 1 - Standard Docker Engine Install `docker` and `docker-compose` via the [official docker page](https://docs.docker.com/compose/install/#scenario-one-install-docker-desktop). If you cannot use the official docker engine due to restrictions of its license, see the option below about using Podman instead of Docker.