mirror/factorio-docker
1
0
Fork 0
mirror of https://github.com/factoriotools/factorio-docker.git synced 2025-01-23 16:24:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc update

Browse Source
This commit is contained in:
David Andersen 2016-10-25 10:28:04 -07:00
parent 8a3df67b52
commit ddf7f99a2b
1 changed files with 39 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -19,18 +19,18 @@ NOTE: This is only the server. The game is available on [Steam](http://store.ste
# Features # Features
* Automatically takes latest save or autosave when restarting the container. * Configurable via ```server-config.json```.
* Volumes for saves and mods * Automatically loads the last save.
* Set autosave interval and number of saves. * Volumes for saves and mods.
* Enable/disable the no-auto-pause option. * Small size. Based on Alpine Linux.
* Enable/disable console commands in game.
* Based on Alpine Linux.
# How to use this image? # How to use this image?
## Quick Start ## Quick Start
Create ```server-config.json``` and modify it to your liking. Now run: Create ```server-config.json``` and modify it to your liking.
Now start the server:
``` ```
docker run -d -P \ docker run -d -P \
@ -41,22 +41,46 @@ docker run -d -P \
dtandersen/factorio dtandersen/factorio
``` ```
```-d``` starts the server as a daemon. ```-P``` exposes all ports. The ```-v``` options mount volumes on the local file system to the container for config, mods, and saves. ```dtandersen/factorio``` is the docker images name. ```--name``` gives the container a name instead of a random name. If you're wondering what all these options are:
The server should start and create ```/path/to/saves/save.zip```. This save is used when the server is restarted. * ```-d``` - Start the server as a daemon.
* ```-P``` - Expose all ports.
* ```-v``` - Mount volumes for config, mods, and saves.
* ```--name``` - Give the container a name (otherwise it'll be random).
* ```dtandersen/factorio``` - The Docker image name.
The server should start and create ```/path/to/saves/save.zip```. The save remains if the server stops, since the save folder is mounted as a volume.
## Stopping the Server
Assuming the server is named ```factorio```, run:
```
docker stop factorio
```
## Saves
If there are no saves when the server starts, then a new map is generated and saved as ```save.zip```.
Otherwise, the most recent ZIP file in the saves folder is used. To load an old save ```touch save.zip``` and restart the server.
## Mods
Copy them into the mods folder.
## Volumes ## Volumes
* /opt/factorio/saves - save files * ```/opt/factorio/saves``` - Saves (recommened)
* /opt/factorio/mods - save files * ```/opt/factorio/mods``` - Mods (optional)
* /opt/factorio/data/server-config.json - config file * ```/opt/factorio/data/server-config.json``` - Configuration (recommended)
## Ports ## Ports
* 34197/udp - game data * ```34197/udp``` - Client (required)
* 27015/tcp - rcon * ```27015/tcp``` - Remote console (optional)
### Logs ## Logs
Sometimes it's useful to see the logs of a running container: Sometimes it's useful to see the logs of a running container: