NeonXP/dumb-init
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #112 from chriskuehl/clarify-json-syntax

Browse source 
Clarify the importance of JSON syntax for CMD
This commit is contained in:
Buck Evan 2016-08-15 14:20:06 -07:00 committed by GitHub
commit b0bf2eeb17
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -186,7 +186,8 @@ then just `pip install dumb-init`.
## Usage
Once installed inside your Docker container, simply prefix your commands with
`dumb-init`.
`dumb-init` (and make sure that you're using [the recommended JSON
syntax][docker-cmd-json]).
Within a Dockerfile, it's a good practice to use dumb-init as your container's
entrypoint. An "entrypoint" is a partial command that gets prepended to your
@ -209,6 +210,10 @@ Running this same command without `dumb-init` would result in being unable to
stop the container without `SIGKILL`, but with `dumb-init`, you can send it
more humane signals like `SIGTERM`.
It's important that you use [the JSON syntax][docker-cmd-json] for `CMD` and
`ENTRYPOINT`. Otherwise, Docker invokes a shell to run your command, resulting
in the shell as PID 1 instead of dumb-init.
## Building dumb-init
@ -255,3 +260,4 @@ your machine.
[systemd]: https://wiki.freedesktop.org/www/Software/systemd/
[sysvinit]: https://wiki.archlinux.org/index.php/SysVinit
[docker]: https://www.docker.com/
[docker-cmd-json]: https://docs.docker.com/engine/reference/builder/#run