Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docker example updates #4050

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docker example updates #4050

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d8f8a8
Adding note about alternate use of docker-compose
jefftmahoney Nov 12, 2024
627ae06
Removing extra lines
jefftmahoney Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point!
Do you think it will give more context if we modify it to this:

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/).

I'm open to approve it as is. This is a minor suggestion.

## 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.

Expand Down
Loading