From 7180d0351ac18a58029369523a87fe579b99f6f5 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 1 Jun 2014 21:48:31 -0500 Subject: [PATCH] Create README.md --- minecraft-server/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 minecraft-server/README.md diff --git a/minecraft-server/README.md b/minecraft-server/README.md new file mode 100644 index 00000000..7fd6ab9d --- /dev/null +++ b/minecraft-server/README.md @@ -0,0 +1,27 @@ +This docker image provides a Minecraft Server that will automatically download the latest stable, latest snapshot, or any specific server version. + +To simply use the latest stable version, run + + docker run -d -p 25565:25565 minecraft-server + +where the default server port, 25565, will be exposed on your host machine. + +In order to persist the Minecraft data, which you *probably want to do for a real server setup*, use the `-v` argument to map a local path to the `/data' path in the container, such as + + docker run -d -v /path/on/host:/data -p 25565:25565 minecraft-server + +To use a different Minecraft version, pass the `VERSION` environment variable, which can have the value +* LATEST +* SNAPSHOT +* (or a specific version, such as "1.7.9") + + docker run -d -e VERSION=SNAPSHOT -p 25565:25565 minecraft-server + +or + + docker run -d -e VERSION=1.7.9 -p 25565:25565 minecraft-server + +The message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as + + docker run -d -e 'MOTD=My Server' -p 25565:25565 minecraft-server +