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.

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

[#13160] Update documentation to use Docker Compose v2 #13161

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 2 additions & 11 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -239,16 +235,11 @@ The Datastore emulator will be running in the port specified in the `build.prope

<panel header="**Using Docker-based tooling**">

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:

```sh
NeoHW marked this conversation as resolved.
Show resolved Hide resolved
docker-compose run -p 8484:8484 datastore
```

**Verification:** Should receive an "Ok" response in the browser at `http://localhost:8484`.
</panel>
Expand Down
9 changes: 1 addition & 8 deletions docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,11 @@ 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
```
If the above command does not work, you may want to try this instead:
NeoHW marked this conversation as resolved.
Show resolved Hide resolved

```sh
docker-compose run -p 8983:8983 solr
```

**Verification:** the Solr admin console should be accessible in `http://localhost:8983`.

Expand Down
Loading