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.

Sign up for GitHub

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

Docs (readme): Update docs on ENTRYPOINT, CMD and WORKDIR #156

Merged
merged 1 commit into from
Nov 11, 2023
Merged

Docs (readme): Update docs on ENTRYPOINT, CMD and WORKDIR #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,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#L114), and the `CMD` is [`""`](build/Dockerfile#L115). 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#L13-L18) in container manifests.
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#L13-L16) 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-L13) in container manifests. Alternatively, they can be modified with custom built images.
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-L12) in container manifests. Alternatively, they can be modified with custom built images.

#### WORKDIR

The default [work directory](build/Dockerfile#L112) for all the images is [`/server`](build/Dockerfile#L7) within which all of a game's files reside.
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.

#### Starting

Expand Down