Skip to content

Commit

Permalink
Docs (readme): Fix documentation on ENTRYPOINT, CMD, and WORKDIR
Browse files Browse the repository at this point in the history
  • Loading branch information
joeltimothyoh committed Dec 23, 2023
1 parent edcdd12 commit da713cd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,13 +200,13 @@ The following are some guidelines on usage of the provided images with `docker`.

#### ENTRYPOINT and CMD

The default `ENTRYPOINT` for all game images is [`"bash", "-c"`](build/Dockerfile#L135), and the `CMD` is [`""`](build/Dockerfile#L136). These values allow a string of initialization commands to be executed before invocation of the game binary, similar to what is commonly achieved with `docker-entrypoint.sh`, or through [multi-line commands](docs/samples/docker-compose/docker-compose.bash-c.yml#L14-L18) in container manifests.
The default `ENTRYPOINT` for all game images is [`"bash", "-c"`](build/Dockerfile#L143), and the `CMD` is [`""`](build/Dockerfile#L144). These values allow a string of initialization commands to be executed before invocation of the game binary, similar to what is commonly achieved with `docker-entrypoint.sh`, or through [multi-line commands](docs/samples/docker-compose/docker-compose.bash-c.yml#L14-L18) in container manifests.

While the default values may not always be intuitive, they can be overridden with the `docker run` `--entrypoint` parameter, or through their respective [configuration options](docs/samples/docker-compose/docker-compose.binary.yml#L10-L11) in container manifests. Alternatively, they can be modified with custom built images.

#### WORKDIR

The default [work directory](build/Dockerfile#L133) for all the images is [`/server`](build/Dockerfile#L7) within which all of a game's files reside.
The default [work directory](build/Dockerfile#L141) for all the images is [`/server`](build/Dockerfile#L7) within which all of a game's files reside.

#### Starting

Expand Down

0 comments on commit da713cd

Please sign in to comment.