Skip to content

Commit 84606c9

Browse files
authored
docs: Update the usage instructions with the latest information (#85)
* `docker run -d groonga/pgroonga` failed to start due to an error. * The error was caused by the missing `POSTGRES_PASSWORD` setting, so add it. * Use `docker container run` instead of `docker run` * Add `--rm` to ensure that no containers remain after running. * About Docker Comose * Currently, using `compose.yaml` * Do not specify `version`. * Use the command `docker compose`
1 parent 2853afd commit 84606c9

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -682,17 +682,16 @@ Those images based on [postgres](https://hub.docker.com/_/postgres) and could us
682682
## Quick start
683683

684684
```shell
685-
docker run -d groonga/pgroonga
685+
docker container run --rm --detach --env POSTGRES_PASSWORD="Please-set-a-password" groonga/pgroonga
686686
```
687687

688688
## How to use
689689

690690
Here is a simple example for use by [docker-compose](https://github.com/docker/compose).
691691

692-
Create `docker-compose.yml` with lines below.
692+
Create `compose.yaml` with lines below.
693693

694694
```docker-compose
695-
version: '2'
696695
services:
697696
PGroonga:
698697
image: groonga/pgroonga:latest
@@ -704,7 +703,7 @@ services:
704703
POSTGRES_USER: PGroonga
705704
```
706705

707-
now You can use `docker-compose up -d` command to start service.
706+
now You can use `docker compose up -d` command to start service.
708707
by use any database manage tool to connect to database `PGroonga`,exceute command below to active PGroonga extension
709708

710709
```SQL

0 commit comments

Comments
 (0)