From 260180d4514c7e2dadc6a6ce3dc082cb676e94c5 Mon Sep 17 00:00:00 2001 From: Wouter Deconinck Date: Thu, 25 Apr 2024 10:49:13 -0500 Subject: [PATCH] docs: use `docker compose` as default in Compose V2 Docker Compose V1 (which uses the `docker-compose` syntax) is not supported anymore. Instructions were updated for Docker Compose V2, which uses the `docker compose` subcommand. A link to migration notes was added. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e58d78e..870164d 100644 --- a/README.md +++ b/README.md @@ -26,22 +26,24 @@ Example of read call to get last Payload for Global tag "sPHENIX_ExampleGT_24" a ## How to start the services -The npdb web app can be built and started by using `docker-compose` within the +The npdb web app can be built and started by using `docker compose` within the cloned repository: ```shell -docker-compose up --build +docker compose up --build ``` This option may be preferred for local development and tests. In order to stop the services run the following command: ```shell -docker-compose down +docker compose down ``` +In Docker Compose V1 one may need to use `docker-compose`; see details on +[migrating to Docker Compose V2](https://docs.docker.com/compose/migrate/) The database and web services can be also started individually. The following -commands are essentially equivalent to the above procedure with `docker-compose` +commands are essentially equivalent to the above procedure with `docker compose` and are shown here for the reference: ```shell