From 364459686bcede30f1cead4627220006a120b88d Mon Sep 17 00:00:00 2001 From: NeoHW Date: Sat, 3 Aug 2024 18:22:45 +0800 Subject: [PATCH 1/4] Update docs to use docker compose v2 --- docs/development.md | 10 +--------- docs/search.md | 5 ----- 2 files changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/development.md b/docs/development.md index 864934222a3..a382246fd39 100644 --- a/docs/development.md +++ b/docs/development.md @@ -63,16 +63,12 @@ In order for the back-end to properly work, you need to have a running database The details on how to run them locally can be found [here (for local Datastore emulator)](#running-the-datastore-emulator) and [here (for full-text search service)](search.md). -If you have access to Docker, we have a Docker compose definition to run those services: +If you have access to Docker, we recommend using Docker Compose v2 to run those services: ```sh docker compose up -d ``` -If the above command does not work, you may not have the updated v2 version of Docker. You may want to try this instead: -```sh -docker-compose up -d -``` For more information on Docker, you may wish to refer to the [Docker Documentation](https://docs.docker.com/compose/reference/). ### Starting the dev server @@ -246,10 +242,6 @@ docker compose run -p 8484:8484 datastore ``` If the above command does not work, you may want to try this instead: -```sh -docker-compose run -p 8484:8484 datastore -``` - **Verification:** Should receive an "Ok" response in the browser at `http://localhost:8484`. diff --git a/docs/search.md b/docs/search.md index f353f4085ab..cf1152f96a3 100644 --- a/docs/search.md +++ b/docs/search.md @@ -19,11 +19,6 @@ We have provided a Docker compose definition to run dependent services, includin ```sh docker compose run -p 8983:8983 solr ``` -If the above command does not work, you may want to try this instead: - -```sh -docker-compose run -p 8983:8983 solr -``` **Verification:** the Solr admin console should be accessible in `http://localhost:8983`. From 83daa89115478df9608828b59bbe15df28d54e7c Mon Sep 17 00:00:00 2001 From: NeoHW Date: Wed, 28 Aug 2024 22:10:38 +0800 Subject: [PATCH 2/4] retrigger checks From e1b39a81c7dc5424acf26b34efee9a5236189b9d Mon Sep 17 00:00:00 2001 From: NeoHW Date: Tue, 3 Sep 2024 02:34:57 +0800 Subject: [PATCH 3/4] Update development.md language for docker usage --- docs/development.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/development.md b/docs/development.md index a382246fd39..e5c2199d103 100644 --- a/docs/development.md +++ b/docs/development.md @@ -235,12 +235,11 @@ The Datastore emulator will be running in the port specified in the `build.prope -We have a Docker compose definition to run dependent services, including local Datastore emulator. Run it under the `datastore` service name and bind to the container port `8484`: +Docker Compose v2 is used to run dependent services, including local Datastore emulator. Run it under the `datastore` service name and bind to the container port `8484`: ```sh docker compose run -p 8484:8484 datastore ``` -If the above command does not work, you may want to try this instead: **Verification:** Should receive an "Ok" response in the browser at `http://localhost:8484`. From cc337523a3144fd08b965128e9c8ba6f252cb95f Mon Sep 17 00:00:00 2001 From: NeoHW Date: Tue, 3 Sep 2024 02:39:48 +0800 Subject: [PATCH 4/4] Update search.md for docker compose v2 usage --- docs/search.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/search.md b/docs/search.md index cf1152f96a3..4605b4d0e3e 100644 --- a/docs/search.md +++ b/docs/search.md @@ -12,9 +12,7 @@ This document will assume Solr version `8.11.1`. ## Setting up Solr using Docker -If you have access to Docker, this method is straightforward and recommended. - -We have provided a Docker compose definition to run dependent services, including Solr. Run it under the `solr` service name and bind to the container port `8983`: +If you have access to Docker, we recommend using Docker Compose v2 to run the dependent services, including Solr. Run it under the `solr` service name and bind to the container port `8983`: ```sh docker compose run -p 8983:8983 solr