Updated readme how to config, how rcon works, etc.

readme.md

@@ -2,63 +2,94 @@
 
 This is Minecraft, running under docker, using docker-compose.
 
-## Getting Started
-
-Edit docker-compose.yml
-Edit data/server.properties, data/ops.txt
-Edit data/plugins/ configurations...
+## Prerequisites
 
-### Prerequisites
-
-Docker
-Possibly, docker configured to run as non-root
+* Docker
+* docker-compose
+* Possibly docker configured to run as non-root
 
 https://docs.docker.com/engine/installation/linux/linux-postinstall/
 
-### Newer Server
+## Getting Started
+
+* Edit docker-compose.yml
+* Edit data/server.properties, data/ops.txt
+* Edit data/plugins/ configurations...
 
-https://ci.destroystokyo.com/job/PaperSpigot/
+In the docker-compose.yml, set UID and GID to the numerical IDs of your current user account.  Or the image will use the default values 1000 as defined the the Dockerfile.
 
-### Newer Plugins
+## Building Image and Running
 
-(need link)
+* docker-compose build
+* docker-compose up -d
+* docker-compose logs -f
 
-### Installing
+Or, if you're having errors starting up, just docker-compose up.
 
-docker-compose build
-docker-compose up -d
-Or, if you're having errors starting up, just docker-compose up. 
-(Which will display the logs to the console.)
+This will display the logs to the console. Ctrl-c stops the container.  Ctrl-p, Ctrl-q detaches the console.
 
 ## Deployment
 
-Edit docker-compose.yml file to chang the port.
+Edit docker-compose.yml file to set the port.
 
     ports:
       - "25565:25565"
 
-This maps the external port (that everyone connects in on) to 25565.
-To use the external port 20065, you would use:
+The first number is the external port that everyone connects in on, which is the default Minecraft port.  The second number is the port minecraft server listens on.
+
+To use port 20065, change to:
 
     ports:
       - "20065:25565"
 
-**Note: You'll need to include 20065 to connect to this non-standard server port.**
+**Note: You'll need to use 20065 in the Minecraft client to this non-standard port number.**
 
-## Authors
+I don't recommend you change the Minecraft port number on the server side.  There's no need to with Docker!  But, if you really, really want to, here's what you'll need to update:
 
-* **Steve Thielemann** 
+* Change the Minecraft port in the server.properties file
+* Change the value following the : in the docker-compose.yml ports settings to the new port number
+* Update Dockerfile EXPOSE line with new port number
+* Update Dockerfile HEALTHCHECK line to localhost:NEW_PORT
 
-## Acknowledgments
+Rebuild the image with docker-compose build.
 
-* https://hub.docker.com/r/itzg/minecraft-server/
+## Using Save and Shutdown
 
-For giving me my first taste of running minecraft server under docker.
+This docker image will use rcon to send a message to users, sleep 1 second, issue /save-all, sleep 1 second, and /stop.
+
+In order for this to work rcon must be enabled in server.properties.
+
+In data/server.properties set:
+
+* rcon.port=25575
+* rcon.password=mindcraft
+* enable-rcon=true
 
-And for the headaches of updating that made me want to try to build my own image.
+## Is it safe to enable rcon? Is this secure?
 
-My image shuts down correctly, and doesn't need SIG_KILL!
+Yes, so long as you don't expose the rcon port 25575 to the world in docker-compose.yml.  If you do expose the rcon port, then you must change the rcon.password and update the docker image launch.sh script.  In launch.sh change the rcon port and password information on the line starting with RCON=.  Expose the rcon port by adding a line to the ports section of the docker-compose.yml.
 
+## Running other Minecraft Servers
 
+This image doesn't just run paper.  It'll run any minecraft server.  Just grab the server jar file, copy into data directory, edit docker-compose.yml file and edit the environment SERVER value to match the name of your jar file.
 
+### Downloading a Newer Server
+
+https://ci.destroystokyo.com/job/PaperSpigot/
+
+### Newer Plugins
+
+(need link)
+
+
+## Author
+
+* **Steve Thielemann** 
+
+## Acknowledgments
+
+* https://hub.docker.com/r/itzg/minecraft-server/
+
+For giving me my first taste of running minecraft server under docker.
 
+And for the headaches from trying to update minecraft versions that made me want to try to build my own image.