Merge pull request #220 from MagicHack/master

Update to 0.17.13

0.16/Dockerfile

@@ -9,8 +9,13 @@ ARG PGID=845
 
 ENV PORT=34197 \
     RCON_PORT=27015 \
-    VERSION=0.16.29 \
-    SHA1=4015ab311b3b769f9ac2fb33f83d0ee3474c6cc7
+    VERSION=0.16.51 \
+    SHA1=127e7ff484ab263b13615d6114013ce0a66ac929 \
+    SAVES=/factorio/saves \
+    CONFIG=/factorio/config \
+    MODS=/factorio/mods \
+    SCENARIOS=/factorio/scenarios \
+    SCRIPTOUTPUT=/factorio/script-output
 
 RUN mkdir -p /opt /factorio && \
     apk add --update --no-cache pwgen && \
@@ -21,8 +26,10 @@ RUN mkdir -p /opt /factorio && \
     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 /factorio/mods /opt/factorio/mods && \
+    ln -s $SAVES /opt/factorio/saves && \
+    ln -s $MODS /opt/factorio/mods && \
+    ln -s $SCENARIOS /opt/factorio/scenarios && \
+    ln -s $SCRIPTOUTPUT /opt/factorio/script-output && \
     apk del .build-deps && \
     addgroup -g $PGID -S $GROUP && \
     adduser -u $PUID -G $GROUP -s /bin/sh -SDH $USER && \
@@ -32,7 +39,7 @@ VOLUME /factorio
 
 EXPOSE $PORT/udp $RCON_PORT/tcp
 
-COPY ./docker-entrypoint.sh /
+COPY files/ /
 
 USER $USER
 

0.16/files/docker-entrypoint.sh

@@ -1,17 +1,13 @@
 #!/bin/sh -x
-
 set -e
 
 id
 
-SAVES=/factorio/saves
-CONFIG=/factorio/config
-
 mkdir -p $SAVES
-mkdir -p /factorio/mods
 mkdir -p $CONFIG
-
-#chown -R factorio /factorio
+mkdir -p $MODS
+mkdir -p $SCENARIOS
+mkdir -p $SCRIPTOUTPUT
 
 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  \
@@ -44,4 +44,5 @@ exec /opt/factorio/bin/x64/factorio \
   --server-banlist $CONFIG/server-banlist.json \
   --rcon-port $RCON_PORT \
   --rcon-password "$(cat $CONFIG/rconpw)" \
-  --server-id /factorio/config/server-id.json
+  --server-id /factorio/config/server-id.json \
+  $@

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

0.17/Dockerfile

@@ -0,0 +1,44 @@
+FROM frolvlad/alpine-glibc:alpine-3.9
+
+MAINTAINER https://github.com/dtandersen/docker_factorio_server
+
+ARG USER=factorio
+ARG GROUP=factorio
+ARG PUID=845
+ARG PGID=845
+
+ENV PORT=34197 \
+    RCON_PORT=27015 \
+    VERSION=0.17.13 \
+    SHA1=7451e8423c62390487311514907fea417f52fed5 \
+    SAVES=/factorio/saves \
+    CONFIG=/factorio/config \
+    MODS=/factorio/mods \
+    SCENARIOS=/factorio/scenarios \
+    SCRIPTOUTPUT=/factorio/script-output
+
+RUN mkdir -p /opt /factorio && \
+    apk add --update --no-cache pwgen su-exec binutils gettext libintl && \
+    apk add --update --no-cache --virtual .build-deps curl && \
+    curl -sSL https://www.factorio.com/get-download/$VERSION/headless/linux64 \
+        -o /tmp/factorio_headless_x64_$VERSION.tar.xz && \
+    echo "$SHA1  /tmp/factorio_headless_x64_$VERSION.tar.xz" | sha1sum -c && \
+    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 $SAVES /opt/factorio/saves && \
+    ln -s $MODS /opt/factorio/mods && \
+    ln -s $SCENARIOS /opt/factorio/scenarios && \
+    ln -s $SCRIPTOUTPUT /opt/factorio/script-output && \
+    apk del .build-deps && \
+    addgroup -g $PGID -S $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 files/ /
+
+ENTRYPOINT ["/docker-entrypoint.sh"]

0.17/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2'
+services:
+  factorio:
+    build: .
+    ports:
+     - "34197:34197/udp"
+     - "27015:27015/tcp"
+    volumes:
+     - /opt/factorio:/factorio
+#    user: 845:845
+#    user: 1000:1000

0.17/files/docker-entrypoint.sh

@@ -0,0 +1,66 @@
+#!/bin/sh -x
+set -e
+
+id
+
+FACTORIO_VOL=/factorio
+mkdir -p $FACTORIO_VOL
+mkdir -p $SAVES
+mkdir -p $CONFIG
+mkdir -p $MODS
+mkdir -p $SCENARIOS
+mkdir -p $SCRIPTOUTPUT
+
+if [ ! -f $CONFIG/rconpw ]; then
+  # Generate a new RCON password if none exists
+  echo $(pwgen 15 1) > $CONFIG/rconpw
+fi
+
+if [ ! -f $CONFIG/server-settings.json ]; then
+  # Copy default settings if server-settings.json doesn't exist
+  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
+
+if find -L $SAVES -iname \*.tmp.zip -mindepth 1 -print | grep -q .; then
+  # Delete incomplete saves (such as after a forced exit)
+  rm -f $SAVES/*.tmp.zip
+fi
+
+if [ "$(id -u)" = '0' ]; then
+  # Take ownership of factorio data if running as root
+  chown -R factorio:factorio $FACTORIO_VOL
+  # Make sure we own temp
+  #mkdir -p /opt/factorio/temp
+  #chown -R factorio:factorio /opt/factorio/temp
+  # Drop to the factorio user
+  SU_EXEC="su-exec factorio"
+fi
+
+if ! find -L $SAVES -iname \*.zip -mindepth 1 -print | grep -q .; then
+  # Generate a new map if no save ZIPs exist
+  ${SU_EXEC} /opt/factorio/bin/x64/factorio \
+    --create $SAVES/_autosave1.zip  \
+    --map-gen-settings $CONFIG/map-gen-settings.json \
+    --map-settings $CONFIG/map-settings.json
+fi
+
+exec ${SU_EXEC} /opt/factorio/bin/x64/factorio \
+  --port $PORT \
+  --start-server-load-latest \
+  --server-settings $CONFIG/server-settings.json \
+  --server-banlist $CONFIG/server-banlist.json \
+  --rcon-port $RCON_PORT \
+  --server-whitelist $CONFIG/server-whitelist.json \
+  --use-server-whitelist \
+  --server-adminlist $CONFIG/server-adminlist.json \
+  --rcon-password "$(cat $CONFIG/rconpw)" \
+  --server-id /factorio/config/server-id.json \
+  "$@"

0.17/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.17/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,15 +1,16 @@
 # 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.29`, `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.17.13`, `0.17`, `latest` [(0.17/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.17/Dockerfile)
+* `0.16.51`, `0.16`, `stable` [(0.16/Dockerfile)](https://github.com/dtandersen/docker_factorio_server/blob/master/0.16/Dockerfile)
+* `0.15.40`, `0.15` [(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)
 
 *Tag descriptions*
 
-* `latest` - highest version: may be experimental.
-* `stable` - highest version declared stable.
-* `0.x` - highest version in a branch: may be experimental.
+* `latest` - most up-to-date version (may be experimental).
+* `stable` - version declared stable on [factorio.com](https://www.factorio.com).
+* `0.x` - latest version in a branch.
 * `0.x.y` - a specific version.
 * `0.x-dev` - whatever is in master for that version.
 
@@ -39,7 +40,7 @@ sudo docker run -d \
   -p 27015:27015/tcp \
   -v /opt/factorio:/factorio \
   --name factorio \
-  --restart=always  \
+  --restart=always \
   dtandersen/factorio
 ```
 
@@ -113,6 +114,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.
@@ -131,6 +164,49 @@ Create file `config/server-whitelist.json` and add the whitelisted users.
 		"friend"
 	]
 
+## Banlisting (0.17.1+)
+
+Create file `config/server-banlist.json` and add the banlisted users.
+
+    [
+        "bad_person",
+        "other_bad_person"
+    ]
+
+## Adminlisting (0.17.1+)
+
+Create file `config/server-adminlist.json` and add the adminlisted users.
+
+    [
+        "you",
+        "friend"
+    ]
+
+## Customize configuration files (0.17.x+)
+
+Out-of-the box, factorio does not support environment variables inside the configuration files. A workaround is the usage of `envsubst` which generates the configuration files dynamically during startup from environment variables set in docker-compose:
+
+Example which replaces the server-settings.json:
+
+
+	factorio_1:
+	  image: dtanders/factorio
+	  ports:
+	    - "34197:34197/udp"
+	  volumes:
+	   - /opt/factorio:/factorio
+	   - ./server-settings.json:/server-settings.json
+	  environment:
+	    - INSTANCE_NAME=Your Instance's Name
+	    - INSTANCE_DESC=Your Instance's Description
+	  entrypoint: /bin/sh -c "mkdir -p /factorio/config && envsubst < /server-settings.json > /factorio/config/server-settings.json && exec /docker-entrypoint.sh"
+
+The `server-settings.json` file may then contain the variable references like this:
+
+	"name": "${INSTANCE_NAME}",
+	"description": "${INSTANCE_DESC}",
+
+
 # Container Details
 
 The philosophy is to [keep it simple](http://wiki.c2.com/?KeepItSimple).
@@ -144,10 +220,15 @@ The philosophy is to [keep it simple](http://wiki.c2.com/?KeepItSimple).
 
 To keep things simple, the container uses a single volume mounted at `/factorio`. This volume stores configuration, mods, and saves.
 
+The files in this volume should be owned by the factorio user, uid 845.
+
     factorio
     |-- config
     |   |-- map-gen-settings.json
+    |   |-- map-settings.json
     |   |-- rconpw
+    |   |-- server-adminlist.json
+    |   |-- server-banlist.json
     |   |-- server-settings.json
     |   `-- server-whitelist.json
     |-- mods
@@ -155,7 +236,6 @@ To keep things simple, the container uses a single volume mounted at `/factorio`
     `-- saves
         `-- _autosave1.zip
 
-
 ## Docker Compose
 
 [Docker Compose](https://docs.docker.com/compose/install/) is an easy way to run Docker containers.
@@ -227,17 +307,17 @@ sudo docker run -d \
   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:
+## Vagrant
+
+[Vagrant](https://www.vagrantup.com/) is a easy way to setup a virtual machine (VM) to run Docker. The [Factorio Vagrant box repository](https://github.com/dtandersen/factorio-lan-vagrant) contains a sample Vagrantfile.
+
+For LAN games the VM needs an internal IP in order for clients to connect. One way to do this is with a public network. The VM uses DHCP to acquire an IP address. The VM must also forward port 34197.
 
 ```
   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**
@@ -256,7 +336,10 @@ 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.
+* [DBendit](https://github.com/DBendit/docker_factorio_server) - Admin list, ban list, version updates
 * [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