lib/arvbox/docker/runit-docker/README.md

   1 # runit-docker
   2
   3 Docker and `runsvdir` don't quite agree on what each signal means, causing
   4 TONS of frustration when attempting to use `runsvdir` as init under Docker.
   5 `runit-docker` is a plug'n'play adapter library which does signal translation
   6 without the overhead and nuisance of running a nanny process.
   7
   8 ## Features
   9
  10 * Pressing Ctrl-C does a clean shutdown.
  11 * `docker stop` does a clean shutdown.
  12
  13 Under the hood, `runit-docker` translates `SIGTERM` and `SIGINT` to `SIGHUP`.
  14
  15 ## Usage
  16
  17 * Build with `make`, install with `make install`.
  18 * Add `CMD ["/sbin/runit-docker"]` to your `Dockerfile`.
  19 * Run `debian/rules clean build binary` to build a Debian package.
  20
  21 ## Author
  22
  23 runit-docker was written by Kosma Moczek &lt;kosma.moczek@pixers.pl&gt; during a single Scrum
  24 planning meeting. Damn meetings.