Updated readme

This commit is contained in:
Marcel Otte 2016-01-10 11:48:35 +01:00
parent 27354d6133
commit d066e0a1d2
1 changed files with 17 additions and 1 deletions

View File

@ -5,3 +5,19 @@ check out and build with
or use the image on dockerhub: or use the image on dockerhub:
https://registry.hub.docker.com/u/qwick/terasology/ 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.