From d066e0a1d268a70f6da3d7abfeb46989fab246d6 Mon Sep 17 00:00:00 2001 From: Marcel Otte Date: Sun, 10 Jan 2016 11:48:35 +0100 Subject: [PATCH] Updated readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d97e655..6918e17 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ # docker-terasology -check out and build with +check out and build with ```docker build .``` or use the image on dockerhub: https://registry.hub.docker.com/u/qwick/terasology/ + +## Small guide + +Be aware that this image provides a bare terasology server, if you want to enable specific modules, you have to do this yourself. + +Just bind the provided volume of the container to a local directory and edit the generated config.cfg after the first run of the container. + +Best practice would be cloning this repository and using docker-compose to pull and start the image. + 1. Edit the ```docker-compose.yml``` file for the location of the volume mount. + * Pull the image with ```docker-compose pull```. + * Start it with ```docker-compose up``` and watch the output for errors. + * Edit the generated config.cfg at the location of the mount and proceed with 3. until your server runs like you want. + +There may be standard configurations in the future for specific use cases, may be... ;-) + +One thing's for sure, I'll keep this a little more updated after this long time of silence.