Create README.md

This commit is contained in:
Geoff Bourne 2014-06-01 21:48:31 -05:00
parent 8a52ebc412
commit 7180d0351a
1 changed files with 27 additions and 0 deletions

View File

@ -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