From ba68274a7b8db38cac7fbd096d388bd4fcb730b9 Mon Sep 17 00:00:00 2001 From: David Andersen Date: Wed, 26 Oct 2016 16:41:54 -0700 Subject: [PATCH] revise docs --- README.md | 52 +++++++++++++++++++++------------------------------- 1 file changed, 21 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 2b6ab69..9dd5439 100644 --- a/README.md +++ b/README.md @@ -30,33 +30,37 @@ NOTE: This is only the server. The game is available on [Steam](http://store.ste ## Quick Start -Start the server in interactive mode. - -``` -docker run --rm -it -P -v /tmp/factorio:/factorio dtandersen/factorio -``` - -Here is an explanation of the options: - -* ```--rm``` - Remove container after stopping -* ```-it``` - Interactive mode, i.e. you can see the console -* ```-P``` - Expose all ports. -* ```-v``` - Volume to mount. - -Press ^C to stop the server. There is now a ```server-settings.json``` in ```/tmp/factorio/config```. Modify this to your liking. - -Now start the server as a daemon. +Begin by running the server to create the necessary folder structure and configuration files under ```/tmp/factorio```. ``` docker run -d -P -v /tmp/factorio:/factorio --name factorio dtandersen/factorio ``` -Try to connect to the server. Check the logs if it isn't working: +Here is an explanation of the options: + +* ```--d``` - Run as a daemon (detached). +* ```-P``` - Expose all ports. +* ```-v``` - Mount ```/tmp/factorio``` on the local file system to ```/factorio``` in the container. +* ```--name``` - Name the container ```factorio``` (otherwise it has a random name). + +Check the logs to see what happened: ``` docker logs factorio ``` +Stop the server: + +```docker stop factorio``` + +Now there's a ```server-settings.json``` in ```/tmp/factorio/config```. Modify this to your liking. + +Restart the server: + +```docker start factorio``` + +Try to connect to the server. Check the logs if it isn't working. + ## Saves A new map (```save.zip```) is generated the first time the server is started. On subsequent runs the newest save is used. To load an old save ```touch save.zip``` and restart the server. @@ -69,20 +73,6 @@ For custom map settings edit ```map-gen-settings.json``` in ```/tmp/factorio/con Copy the mods into the mods folder and restart the server. -## Start/Stopping - -Assuming the server is named ```factorio```, to stop the server: - -``` -docker stop factorio -``` - -To restart the server: - -``` -docker start factorio -``` - ## Volumes The server has only one volume: ```/factorio```. Under this folder there are folders for ```/saves```, ```/mods```, and ```/config```.