[mc] Add dinnerbone's mcstatus and use it for HEALTHCHECK

Part of #159
2026-05-06 03:55:24 +00:00 · 2017-06-11 11:01:59 -05:00
parent 123292b56b
commit 5b8668d73f
2 changed files with 33 additions and 1 deletions
@@ -117,6 +117,34 @@ or a specific version:

    docker run -d -e VERSION=1.7.9 ...

+## Healthcheck
+
+This image contains [Dinnerbone's mcstatus](https://github.com/Dinnerbone/mcstatus) and uses
+its `ping` command to continually check on the container's. That can be observed
+from the `STATUS` column of `docker ps`
+
+```
+CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS                    PORTS                                 NAMES
+b418af073764        mc                  "/start"            43 seconds ago      Up 41 seconds (healthy)   0.0.0.0:25565->25565/tcp, 25575/tcp   mc
+```
+
+You can also query the container's health in a script friendly way:
+
+```
+> docker container inspect -f "{{.State.Health.Status}}" mc
+healthy
+```
+
+Finally, since `mcstatus` is on the `PATH` you can exec into the container
+and use mcstatus directly and invoke any of its other commands:
+
+```
+> docker exec mc mcstatus localhost status
+version: v1.12 (protocol 335)
+description: "{u'text': u'A Minecraft Server Powered by Docker'}"
+players: 0/20 No players online
+```
+
 ## Running a Forge Server

 Enable Forge server mode by adding a `-e TYPE=FORGE` to your command-line.