From 0461ddcdb2ae3ca6a61cc79a47d3fe56238c8fd8 Mon Sep 17 00:00:00 2001 From: Jeff Mahoney <jeff.t.mahoney@gmail.com> Date: Tue, 28 Jan 2025 11:23:37 -0500 Subject: [PATCH] Docker example updates (#4050) --- sample/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sample/README.md b/sample/README.md index 6b0109aa263..c16beb856af 100644 --- a/sample/README.md +++ b/sample/README.md @@ -7,6 +7,14 @@ 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. +> +> - 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.