Merge pull request #145 from dtandersen/update-0.16.32

Updated to version 0.16.32

0.16/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.6
+FROM frolvlad/alpine-glibc:alpine-3.7
 
 MAINTAINER https://github.com/dtandersen/docker_factorio_server
 
@@ -9,12 +9,14 @@ ARG PGID=845
 
 ENV PORT=34197 \
     RCON_PORT=27015 \
-    VERSION=0.16.7 \
+    VERSION=0.16.32 \
-    SHA1=7bd14a4d8abe2feef015d1b3d75c6ec82a5e2ccf
+    SHA1=735f8d8a37cddc1fa4ca0e856cfe9b536eee1d2f \
+    SAVES=/factorio/saves \
+    CONFIG=/factorio/config \
+    MODS=/factorio/mods \
+    SCENARIOS=/factorio/scenarios
 
-VOLUME /factorio
+RUN mkdir -p /opt /factorio && \
-
-RUN mkdir -p /opt && \
     apk add --update --no-cache pwgen && \
     apk add --update --no-cache --virtual .build-deps curl && \
     curl -sSL https://www.factorio.com/get-download/$VERSION/headless/linux64 \
@@ -23,16 +25,19 @@ RUN mkdir -p /opt && \
     tar xf /tmp/factorio_headless_x64_$VERSION.tar.xz --directory /opt && \
     chmod ugo=rwx /opt/factorio && \
     rm /tmp/factorio_headless_x64_$VERSION.tar.xz && \
-    ln -s /factorio/saves /opt/factorio/saves && \
+    ln -s $SAVES /opt/factorio/saves && \
-    ln -s /factorio/mods /opt/factorio/mods && \
+    ln -s $MODS /opt/factorio/mods && \
+    ln -s $SCENARIOS /opt/factorio/scenarios && \
     apk del .build-deps && \
     addgroup -g $PGID -S $GROUP && \
-    adduser -u $PUID -G $USER -s /bin/sh -SDH $GROUP && \
+    adduser -u $PUID -G $GROUP -s /bin/sh -SDH $USER && \
     chown -R $USER:$GROUP /opt/factorio /factorio
 
+VOLUME /factorio
+
 EXPOSE $PORT/udp $RCON_PORT/tcp
 
-COPY ./docker-entrypoint.sh /
+COPY files/ /
 
 USER $USER
 

0.16/docker-compose.yml

@@ -3,6 +3,7 @@ services:
   factorio:
     build: .
     ports:
-     - "34197:34197"
+     - "34197:34197/udp"
+     - "27015:27015/tcp"
     volumes:
      - /opt/factorio:/factorio

0.16/files/docker-entrypoint.sh

@@ -4,14 +4,10 @@ set -e
 
 id
 
-SAVES=/factorio/saves
-CONFIG=/factorio/config
-
 mkdir -p $SAVES
-mkdir -p /factorio/mods
 mkdir -p $CONFIG
-
+mkdir -p $MODS
-#chown -R factorio /factorio
+mkdir -p $SCENARIOS
 
 if [ ! -f $CONFIG/rconpw ]; then
   echo $(pwgen 15 1) > $CONFIG/rconpw
@@ -29,6 +25,10 @@ if [ ! -f $CONFIG/map-settings.json ]; then
   cp /opt/factorio/data/map-settings.example.json $CONFIG/map-settings.json
 fi
 
+if find -L $SAVES -iname \*.tmp.zip -mindepth 1 -print | grep -q .; then
+  rm -f $SAVES/*.tmp.zip
+fi
+
 if ! find -L $SAVES -iname \*.zip -mindepth 1 -print | grep -q .; then
   /opt/factorio/bin/x64/factorio \
     --create $SAVES/_autosave1.zip  \

0.16/files/scenario.sh

@@ -0,0 +1,44 @@
+#!/bin/sh -x
+if [ -z "$1" ]
+  then
+    echo "No argument supplied"
+fi
+SCENARIO=$1
+
+set -e
+
+id
+
+mkdir -p $SAVES
+mkdir -p $CONFIG
+mkdir -p $MODS
+mkdir -p $SCENARIOS
+
+#chown -R factorio /factorio
+
+if [ ! -f $CONFIG/rconpw ]; then
+  echo $(pwgen 15 1) > $CONFIG/rconpw
+fi
+
+if [ ! -f $CONFIG/server-settings.json ]; then
+  cp /opt/factorio/data/server-settings.example.json $CONFIG/server-settings.json
+fi
+
+if [ ! -f $CONFIG/map-gen-settings.json ]; then
+  cp /opt/factorio/data/map-gen-settings.example.json $CONFIG/map-gen-settings.json
+fi
+
+if [ ! -f $CONFIG/map-settings.json ]; then
+  cp /opt/factorio/data/map-settings.example.json $CONFIG/map-settings.json
+fi
+
+
+exec /opt/factorio/bin/x64/factorio \
+  --port $PORT \
+  --start-server-load-scenario $SCENARIO \
+  --server-settings $CONFIG/server-settings.json \
+  --server-whitelist $CONFIG/server-whitelist.json \
+  --server-banlist $CONFIG/server-banlist.json \
+  --rcon-port $RCON_PORT \
+  --rcon-password "$(cat $CONFIG/rconpw)" \
+  --server-id /factorio/config/server-id.json

0.16/files/scenario2map.sh

@@ -0,0 +1,30 @@
+#!/bin/sh -x
+if [ -z "$1" ]
+  then
+    echo "No argument supplied"
+fi
+SCENARIO=$1
+
+set -e
+
+id
+
+mkdir -p $SAVES
+mkdir -p $CONFIG
+mkdir -p $MODS
+mkdir -p $SCENARIOS
+
+if [ ! -f $CONFIG/server-settings.json ]; then
+  cp /opt/factorio/data/server-settings.example.json $CONFIG/server-settings.json
+fi
+
+if [ ! -f $CONFIG/map-gen-settings.json ]; then
+  cp /opt/factorio/data/map-gen-settings.example.json $CONFIG/map-gen-settings.json
+fi
+
+if [ ! -f $CONFIG/map-settings.json ]; then
+  cp /opt/factorio/data/map-settings.example.json $CONFIG/map-settings.json
+fi
+
+exec /opt/factorio/bin/x64/factorio \
+  --scenario2map $SCENARIO

README.md

@@ -1,6 +1,6 @@
 # Factorio [![](https://images.microbadger.com/badges/image/dtandersen/factorio.svg)](https://microbadger.com/images/dtandersen/factorio "Get your own image badge on microbadger.com") [![Docker Pulls](https://img.shields.io/docker/pulls/dtandersen/factorio.svg)](https://hub.docker.com/r/dtandersen/factorio/) [![Docker Stars](https://img.shields.io/docker/stars/dtandersen/factorio.svg)](https://hub.docker.com/r/dtandersen/factorio/)
 
-* `0.16.7`, `0.16`, `latest` [(0.16/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.16/Dockerfile)
+* `0.16.32`, `0.16`, `latest` [(0.16/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.16/Dockerfile)
 * `0.15.40`, `0.15`, `stable` [(0.15/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.15/Dockerfile)
 * `0.14.23`, `0.14` [(0.14/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.14/Dockerfile)
 * `0.13.20`, `0.13`  [(0.13/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.13/Dockerfile)
@@ -29,11 +29,15 @@ NOTE: This is only the server. The game is available at [factorio.com](https://w
 
 ## Quick Start
 
-Run the server to create the necessary folder structure and configuration files. For this example data is stored in `/tmp/factorio`.
+Run the server to create the necessary folder structure and configuration files. For this example data is stored in `/opt/factorio`.
 
 ```
-docker run -d -p 34197:34197/udp -p 27015:27015/tcp \
+sudo mkdir -p /opt/factorio
-  -v /tmp/factorio:/factorio \
+sudo chown 845:845 /opt/factorio
+sudo docker run -d \
+  -p 34197:34197/udp \
+  -p 27015:27015/tcp \
+  -v /opt/factorio:/factorio \
   --name factorio \
   --restart=always  \
   dtandersen/factorio
@@ -43,10 +47,12 @@ For those new to Docker, here is an explanation of the options:
 
 * `-d` - Run as a daemon ("detached").
 * `-p` - Expose ports.
-* `-v` - Mount `/tmp/factorio` on the local file system to `/factorio` in the container.
+* `-v` - Mount `/opt/factorio` on the local file system to `/factorio` in the container.
 * `--restart` - Restart the server if it crashes and at system start
 * `--name` - Name the container "factorio" (otherwise it has a funny random name).
 
+The `chown` command is needed because in 0.16+, we no longer run the game server as root for security reasons, but rather as a 'factorio' user with user id 845. The host must therefore allow these files to be written by that user.
+
 Check the logs to see what happened:
 
 ```
@@ -59,7 +65,7 @@ Stop the server:
 docker stop factorio
 ```
 
-Now there's a `server-settings.json` file in the folder `/tmp/factorio/config`. Modify this to your liking and restart the server:
+Now there's a `server-settings.json` file in the folder `/opt/factorio/config`. Modify this to your liking and restart the server:
 
 ```
 docker start factorio
@@ -95,7 +101,7 @@ Now run the server as before. In about a minute the new version of Factorio shou
 
 ## Saves
 
-A new map named `_autosave1.zip` is generated the first time the server is started. The `map-gen-settings.json` and `map-settings.json` files in `/tmp/factorio/config` are used for the map settings. On subsequent runs the newest save is used.
+A new map named `_autosave1.zip` is generated the first time the server is started. The `map-gen-settings.json` and `map-settings.json` files in `/opt/factorio/config` are used for the map settings. On subsequent runs the newest save is used.
 
 To load an old save stop the server and run the command `touch oldsave.zip`. This resets the date. Then restart the server. Another option is to delete all saves except one.
 
@@ -107,6 +113,38 @@ To generate a new map stop the server, delete all of the saves and restart the s
 Copy mods into the mods folder and restart the server.
 
 
+## Scenarios
+
+If you want to launch a scenario from a clean start (not from a saved map) you'll need to start the docker image from an alternate entrypoint. To do this, use the example entrypoint file stored in the /factorio/entrypoints directory in the volume, and launch the image with the following syntax. Note that this is the normal syntax with the addition of the --entrypoint setting AND the additional argument at the end, which is the name of the Scenario in the Scenarios folder.
+
+```
+docker run -d \
+  -p 34197:34197/udp \
+  -p 27015:27015/tcp \
+  -v /opt/factorio:/factorio \
+  --name factorio \
+  --restart=always  \
+  --entrypoint "/scenario.sh" \
+  dtandersen/factorio \
+  MyScenarioName
+```
+
+## Converting Scenarios to Regular Maps
+
+If you would like to export your scenario to a saved map, you can use the example entrypoint similar to the Scenario usag above. Factorio will run once, converting the Scenario to a saved Map in your saves directory. A restart of the docker image using the standard options will then load that map, just as if the scenario were just started by the Scenarios example noted above. 
+
+```
+docker run -d \
+  -p 34197:34197/udp \
+  -p 27015:27015/tcp \
+  -v /opt/factorio:/factorio \
+  --name factorio \
+  --restart=always  \
+  --entrypoint "/scenario2map.sh" \
+  dtandersen/factorio
+  MyScenarioName
+```
+
 ## RCON
 
 Set the RCON password in the `rconpw` file. A random password is generated if `rconpw` doesn't exist.
@@ -150,6 +188,40 @@ To keep things simple, the container uses a single volume mounted at `/factorio`
         `-- _autosave1.zip
 
 
+## Docker Compose
+
+[Docker Compose](https://docs.docker.com/compose/install/) is an easy way to run Docker containers.
+
+First get a [docker-compose.yml](https://github.com/dtandersen/docker_factorio_server/blob/master/0.16/docker-compose.yml) file. To get it from this repository:
+
+```
+git clone https://github.com/dtandersen/docker_factorio_server.git
+cd docker_factorio_server/0.16
+```
+
+Or make your own:
+
+```
+version: '2'
+services:
+  factorio:
+    image: dtandersen/factorio
+    ports:
+     - "34197:34197/udp"
+     - "27015:27015/tcp"
+    volumes:
+     - /opt/factorio:/factorio
+```
+
+Now cd to the directory with docker-compose.yml and run:
+
+```
+sudo mkdir -p /opt/factorio
+sudo chown 845:845 /opt/factorio
+sudo docker-compose up -d
+```
+
+
 ## Ports
 
 * `34197/udp` - Game server (required).
@@ -159,8 +231,45 @@ To keep things simple, the container uses a single volume mounted at `/factorio`
 ## Environment Variables
 
 * `PORT` (0.15+) - Start the server on an alterate port, .e.g. `docker run -e "PORT=34198"`.
+* `RCON_PORT` (0.16+) - Start the RCON on an alterate port, .e.g. `docker run -e "RCON_PORT=34198"`.
 
 
+## LAN Games
+
+Ensure the `lan` setting in server-settings.json is `true`.
+
+```
+  "visibility":
+  {
+    "public": false,
+    "lan": true
+  },
+```
+
+Start the container with the `--network=host` option so clients can automatically find LAN games. Refer to the Quick Start to create the `/opt/factorio` directory.
+
+```
+sudo docker run -d \
+  --network=host \
+  -p 34197:34197/udp \
+  -p 27015:27015/tcp \
+  -v /opt/factorio:/factorio \
+  --name factorio \
+  --restart=always  \
+  dtandersen/factorio
+```
+
+VirtualBox users must enable Bridged networking in order for the host to be assigned an internal network IP. Enable Bridged networking in Vagrant with:
+
+```
+  config.vm.network "public_network"
+  config.vm.network "forwarded_port", guest: 34197, host: 34197
+```
+
+## Vagrant
+
+Vagrant is a good way for those without a Linux machine to try Docker. Check out the [Factorio Vagrant Box](https://github.com/dtandersen/factorio-lan-vagrant).
+
 ## Troubleshooting
 
 **My server is listed in the server browser, but nobody can connect**
@@ -179,7 +288,9 @@ Use the `PORT` environment variable to start the server on the a different port,
 # Contributors
 
 * [dtandersen](https://github.com/dtandersen/docker_factorio_server) - Maintainer
+* [Fank](https://github.com/Fankserver/docker-factorio-watchdog) - Keeper of the Factorio watchdog that keeps the version up-to-date.
 * [Zopanix](https://github.com/zopanix/docker_factorio_server) - Originator
 * [Rfvgyhn](https://github.com/Rfvgyhn/docker-factorio) - Randomly generate RCON password
 * [gnomus](https://github.com/gnomus/docker_factorio_server) - White listing
+* [bplein](https://github.com/bplein/docker_factorio_server) - Scenario support
 * [jaredledvina](https://github.com/jaredledvina/docker_factorio_server) - Version update