Skip to content

Commit

Permalink
Merge pull request #37 from startersclan/docs/readme-simplify-usage-s…
Browse files Browse the repository at this point in the history
…ection

Docs (readme): Simplify usage section
  • Loading branch information
leojonathanoh authored Nov 23, 2023
2 parents 9ebab06 + 5a7577c commit 2226fdd
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,7 @@ a PHP frontend.

## Usage (docker)

> The tag convention is `<version>-<service>` or `<version>-<sha>-<service>`. For instance, for release `v1.2.3` on sha `0abcdef`:
>
> - `web` image tags: `1-web`, `1.2-web`, `1.2.3-web`, `1-0abcdef-web`, `1.2-0abcdef-web`, `1.2.3-0abcdef-web`
> - `daemon` image tags: `1-daemon`, `1.2-daemon`, `1.2.3-daemon`, `1-0abcdef-daemon`, `1.2-0abcdef-daemon`, `1.2.3-0abcdef-daemon`
`web` image (See [./web/config.php](./web/config.php) for supported environment variables):
`web` image (See [./src/web/config.php](./src/web/config.php) for supported environment variables):

```sh
docker run --rm -it -e DB_ADDR=db -e DB_NAME=hlstatsxce -e DB_USER=hlstatsxce -e DB_PASS=hlstatsxce -p 80:80 startersclan/hlstatsx-community-edition:1.9.0-web
Expand All @@ -52,6 +47,8 @@ docker run --rm -it -e DB_ADDR=db -e DB_NAME=hlstatsxce -e DB_USER=hlstatsxce -e
docker run --rm -it -p 27500:27500/udp startersclan/hlstatsx-community-edition:1.9.0-daemon --db-host=db:3306 --db-name=hlstatsxce --db-username=hlstatsxce --db-password=hlstatsxce #--help
```

### Docker Compose

To deploy using Docker Compose:

```sh
Expand Down

0 comments on commit 2226fdd

Please sign in to comment.