Correctly check UPDATE_MODS_ON_START env

Closes #323

.travis.yml

@@ -31,4 +31,4 @@ jobs:
     - <<: *build
       if: branch = master AND type != pull_request
       env:
-      script: docker run -v $PWD:/workspace -e DOCKERHUB_USERNAME=$DOCKER_USERNAME -e DOCKERHUB_PASSWORD=$DOCKER_PASSWORD -e DOCKERHUB_REPOSITORY='factoriotools/factorio' -e README_FILEPATH='/workspace/README.md' peterevans/dockerhub-description:2.1.0
+      script: DOCKERHUB_USERNAME=$DOCKER_USERNAME DOCKERHUB_PASSWORD=$DOCKER_PASSWORD DOCKERHUB_REPOSITORY='factoriotools/factorio' README_FILEPATH='./README.md' ./update-dockerhub-description.sh

0.14/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.9
+FROM frolvlad/alpine-glibc:alpine-3.11
 
 LABEL maintainer="https://github.com/factoriotools/factorio-docker"
 

0.15/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.9
+FROM frolvlad/alpine-glibc:alpine-3.11
 
 LABEL maintainer="https://github.com/factoriotools/factorio-docker"
 

0.16/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.9
+FROM frolvlad/alpine-glibc:alpine-3.11
 
 LABEL maintainer="https://github.com/factoriotools/factorio-docker"
 

0.17/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.9
+FROM frolvlad/alpine-glibc:alpine-3.11
 
 LABEL maintainer="https://github.com/factoriotools/factorio-docker"
 
@@ -19,6 +19,7 @@ ENV PORT=34197 \
     PUID="$PUID" \
     PGID="$PGID"
 
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 RUN set -ox pipefail \
     && archive="/tmp/factorio_headless_x64_$VERSION.tar.xz" \
     && mkdir -p /opt /factorio \
@@ -29,18 +30,14 @@ RUN set -ox pipefail \
     && tar xf "$archive" --directory /opt \
     && chmod ugo=rwx /opt/factorio \
     && rm "$archive" \
-    && 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 \
+    && mkdir -p /opt/factorio/config/ \
     && addgroup -g "$PGID" -S "$GROUP" \
     && adduser -u "$PUID" -G "$GROUP" -s /bin/sh -SDH "$USER" \
     && chown -R "$USER":"$GROUP" /opt/factorio /factorio
 
+COPY files/*.sh /
+COPY files/config.ini /opt/factorio/config/config.ini
+
 VOLUME /factorio
-
 EXPOSE $PORT/udp $RCON_PORT/tcp
-
-COPY files/ /
-
 ENTRYPOINT ["/docker-entrypoint.sh"]

0.17/files/config.ini

@@ -0,0 +1,714 @@
+; version=5
+; This is INI file : https://en.wikipedia.org/wiki/INI_file#Format 
+; Semicolons (;) at the beginning of the line indicate a comment. Comment lines are ignored.
+[path]
+read-data=__PATH__executable__/../../data
+write-data=__PATH__executable__/../..
+
+[general]
+locale=
+
+[other]
+; Options: true, false
+; verbose-logging=false
+
+; Options: true, false
+; log-saving-statistics=false
+
+; autosave-interval=5
+
+; autosave-slots=3
+
+; In ticks
+; minimum-latency-in-multiplayer=0
+
+; In seconds
+; multiplayer-initial-connection-timeout=10
+
+; port=34197
+
+; max-map-preview-chunk-side=64
+
+; max-map-preview-threads=7
+
+; In bytes
+; max-multiplayer-script-reload-size=1048576
+
+; Options: true, false
+; enable-steam-networking=true
+
+; proxy=
+
+; proxy-username=
+
+; proxy-password=
+
+; Options: true, false
+; check-updates=true
+
+; Options: true, false
+; enable-experimental-updates=false
+
+; Options: true, false
+; enable-new-mods=true
+
+; Options: true, false
+; use-mod-settings-per-save=true
+
+; Options: true, false
+; disable-minimal-mode=false
+
+; Options: true, false
+; disable-blueprint-storage=false
+
+; Disables tracking which mod created/changed what prototype. Mainly for faster startup during development.
+; 
+; Options: true, false
+; disable-prototype-history=false
+
+; Print a warning for all prototype values that were not accessed.
+; 
+; Options: true, false
+; check-unused-prototype-data=false
+
+; Options: true, false
+; enable-razer-chroma-support=true
+
+; Options: true, false
+; enable-logitech-led-support=true
+
+; Options: true, false
+; enable-crash-log-uploading=true
+
+; Options: true, false
+; enable-heap-validation=true
+
+; Options: true, false
+; enable-threaded-message-pump=true
+
+; Options: true, false
+; enable-taskbar-animation=true
+
+; Does nothing on Windows
+; 
+; Options: true, false
+; non-blocking-saving=false
+
+; Related to MacOS
+; 
+; Options: true, false
+; discard-mouse-events-when-accessibility-zoomed=false
+
+; Options: true, false
+; enable-blueprint-storage-cloud-sync=false
+
+; Options: fast, maximum
+; multiplayer-compression-level=fast
+
+; Options: none, fast, maximum
+; autosave-compression-level=fast
+
+; Socket to host RCON on when lauching MP server from the menu.
+; local-rcon-socket=0.0.0.0:0
+
+; Password for RCON when launching MP server from the menu.
+; local-rcon-password=
+
+
+[interface]
+; Options: true, false
+; automatic-ui-scale=true
+
+; custom-ui-scale=1.000000
+
+; tooltip-delay=0.040000
+
+; entity-tooltip-delay=0.000000
+
+; tooltip-offset=20
+
+; output-console-delay=1200
+
+; train-stop-label-angle=0.085526
+
+; active-quick-bars=2
+
+; shortcut-bar-rows=2
+
+; Options: true, false
+; force-default-logistic-filter-count-to-one=false
+
+; Options: true, false
+; autosort-inventory=true
+
+; Options: true, false
+; research-finished-stops-game=false
+
+; Options: true, false
+; use-item-groups=true
+
+; Options: true, false
+; use-item-subgroups=true
+
+; Options: true, false
+; use-version-filter-in-browse-games-gui=true
+
+; Options: true, false
+; use-version-filter-in-install-mods-gui=true
+
+; Options: true, false
+; play-sound-for-chat-messages=true
+
+; Options: true, false
+; fuzzy-search-enabled=false
+
+; Options: true, false
+; pick-ghost-cursor=false
+
+; Options: true, false
+; show-minimap=true
+
+; Options: true, false
+; show-tips-and-tricks=true
+
+; Options: true, false
+; show-tutorial-notifications=true
+
+; Options: true, false
+; show-turret-radius-when-blueprinting=false
+
+; Options: true, false
+; show-item-labels-in-cursor=true
+
+; Options: true, false
+; show-rail-block-visualization=true
+
+; Options: true, false
+; show-missing-logistic-network-icon=true
+
+; Options: true, false
+; show-interaction-indications=true
+
+; Options: true, false
+; show-grid-when-paused=true
+
+; Options: true, false
+; show-inserter-arrows-when-selected=true
+
+; Options: true, false
+; show-inserter-arrows-when-detailed-info-is-on=false
+
+; Options: true, false
+; show-pump-arrows-when-detailed-info-is-on=true
+
+; Options: true, false
+; show-mining-drill-arrows-when-detailed-info-is-on=true
+
+; Options: true, false
+; show-combinator-settings-when-detailed-info-is-on=false
+
+; Options: true, false
+; entity-tooltip-on-the-side=true
+
+; Options: true, false
+; show-mod-owners-in-tooltips=true
+
+; Options: true, false
+; show-descriptions-in-tooltips=true
+
+; Options: true, false
+; show-total-raw-in-recipe-tooltips=true
+
+; debug-font-size=18
+
+; train-visualization-length=5
+
+
+[sound]
+; master-volume=0.600000
+
+; music-volume=0.400000
+
+; game-effects-volume=0.700000
+
+; gui-effects-volume=0.700000
+
+; walking-sound-volume=0.300000
+
+; environment-sounds-volume=0.450000
+
+; alerts-volume=0.550000
+
+; wind-volume=0.400000
+
+; audible-distance=40.000000
+
+; environment-audible-distance=15.000000
+
+; maximum-environment-sounds=15
+
+; active-gui-volume-modifier=1.000000
+
+; active-gui-environment-volume-modifier=0.600000
+
+; ambient-music-pause-mean-seconds=45.000000
+
+; ambient-music-pause-variance-seconds=30.000000
+
+; Options: main-tracks-only, interleave-main-tracks-with-interludes, randomize-all
+; ambient-music-mode=interleave-main-tracks-with-interludes
+
+; zoom-audible-distance-coefficient=1.000000
+
+; zoom-volume-coefficient=2.000000
+
+
+[map-view]
+; Options: true, false
+; show-logistic-network=false
+
+; Options: true, false
+; show-electric-network=false
+
+; Options: true, false
+; show-turret-range=false
+
+; Options: true, false
+; show-pollution=true
+
+; Options: true, false
+; show-networkless-logistic-members=false
+
+; Options: true, false
+; show-train-station-names=true
+
+; Options: true, false
+; show-player-names=true
+
+; Options: true, false
+; show-non-standard-map-info=false
+
+
+[debug]
+; force=enemy
+
+; Options: true, false
+; capture-perf-statistics=false
+
+; Options: always, debug, never
+; show-fps=debug
+
+; Options: always, debug, never
+; show-detailed-info=debug
+
+; Options: always, debug, never
+; show-time-usage=debug
+
+; Options: always, debug, never
+; show-gpu-time-usage=debug
+
+; Options: always, debug, never
+; show-sprite-counts=never
+
+; Options: always, debug, never
+; show-lua-object-statistics=never
+
+; Options: always, debug, never
+; show-multiplayer-waiting-icon=debug
+
+; Options: always, debug, never
+; show-multiplayer-statistics=debug
+
+; Options: always, debug, never
+; show-multiplayer-selection-rectangles=never
+
+; Options: always, debug, never
+; show-debug-info-in-tooltips=debug
+
+; Options: always, debug, never
+; hide-mod-guis=never
+
+; Options: always, debug, never
+; show-tile-grid=never
+
+; Options: always, debug, never
+; show-collision-rectangles=never
+
+; Options: always, debug, never
+; show-selection-rectangles=never
+
+; Options: always, debug, never
+; show-render-rectangles=never
+
+; Options: always, debug, never
+; show-entity-positions=never
+
+; Options: always, debug, never
+; show-entity-velocities=never
+
+; Options: always, debug, never
+; show-selected-entity-advanced-tiles=never
+
+; Options: always, debug, never
+; show-selected-input-transport-belts=never
+
+; Options: always, debug, never
+; show-paths=never
+
+; Options: always, debug, never
+; show-path-requests=never
+
+; Options: always, debug, never
+; show-next-waypoint-bb=never
+
+; Options: always, debug, never
+; show-target=never
+
+; Options: always, debug, never
+; show-unit-group-info=never
+
+; Options: always, debug, never
+; show-unit-behavior-info=never
+
+; Options: always, debug, never
+; show-pathfinder-fringe=never
+
+; Options: always, debug, never
+; show-path-cache=never
+
+; Options: always, debug, never
+; show-path-cache-paths=never
+
+; Options: always, debug, never
+; show-rail-paths=never
+
+; Options: always, debug, never
+; show-rolling-stock-count=never
+
+; Options: always, debug, never
+; show-rail-connections=never
+
+; Options: always, debug, never
+; show-rail-joints=never
+
+; Options: always, debug, never
+; show-rail-signal-states=never
+
+; Options: always, debug, never
+; show-rail-segment-collision-boxes=never
+
+; Options: always, debug, never
+; show-train-stop-point=never
+
+; Options: always, debug, never
+; show-train-braking-distance=never
+
+; Options: always, debug, never
+; show-train-signals=never
+
+; Options: always, debug, never
+; show-train-repathing=never
+
+; Options: always, debug, never
+; show-network-connected-entities=never
+
+; Options: always, debug, never
+; show-circuit-network-numbers=never
+
+; Options: always, debug, never
+; show-energy-sources-networks=never
+
+; Options: always, debug, never
+; show-active-state=never
+
+; Options: always, debug, never
+; show-wakeup-lists=never
+
+; Options: always, debug, never
+; show-transport-lines=never
+
+; Options: always, debug, never
+; show-transport-line-gaps=never
+
+; Options: always, debug, never
+; show-pollution-values=never
+
+; Options: always, debug, never
+; show-active-entities-on-chunk-counts=never
+
+; Options: always, debug, never
+; show-active-chunks=never
+
+; Options: always, debug, never
+; show-polluted-chunks=never
+
+; Options: always, debug, never
+; show-enemy-expansion-candidate-chunks=never
+
+; Options: always, debug, never
+; show-enemy-expansion-candidate-chunk-values=never
+
+; Options: always, debug, never
+; show-bad-attack-chunks=never
+
+; Options: always, debug, never
+; show-tile-variations=never
+
+; Options: always, debug, never
+; show-raw-tile-transitions=never
+
+; Options: always, debug, never
+; show-fluid-box-fluid-info=never
+
+; Options: always, debug, never
+; show-environment-sound-info=never
+
+; Options: always, debug, never
+; show-logistic-robot-targets=never
+
+; Options: always, debug, never
+; show-logistic-robots-on-map=never
+
+; Options: always, debug, never
+; show-recipe-icons-on-map=never
+
+; Options: always, debug, never
+; show-player-robots=never
+
+; Options: always, debug, never
+; show-fire-info=never
+
+; Options: always, debug, never
+; show-sticker-info=never
+
+; Options: always, debug, never
+; show-decorative-names=never
+
+; Options: always, debug, never
+; show-decorative-collision-rectangles=never
+
+; Options: always, debug, never
+; allow-increased-zoom=never
+
+; Options: always, debug, never
+; show-chunk-components=never
+
+
+[multiplayer-lobby]
+; name=
+
+; description=
+
+; Options: true, false
+; visibility-public=true
+
+; Options: true, false
+; visibility-steam=true
+
+; Options: true, false
+; visibility-lan=true
+
+; max-players=0
+
+; Options: true, false
+; ignore-player-limit-when-returning=false
+
+; max-upload-in-kilobytes-per-second=0
+
+; max-upload-slots=5
+
+; password=
+
+; tag-list=
+
+; afk-auto-kick=0
+
+; Options: true, false, admins-only
+; allowed-commands=admins-only
+
+; Options: true, false
+; only-admins-can-pause=true
+
+; Options: true, false
+; autosave-only-on-server=true
+
+; Options: true, false
+; non-blocking-saving=true
+
+; Options: true, false
+; verify-user-identity=true
+
+; Options: true, false
+; enable-whitelist=false
+
+
+[graphics]
+; lights-render-quality=0.250000
+
+; Default preferred display index should force finding primary monitor
+; preferred-display-index=255
+
+; screenshots-threads-count=8
+
+; cache-sprite-atlas-count=1
+
+; Options: true, false
+; cache-sprite-atlas=false
+
+; Options: true, false
+; compress-sprite-atlas-cache=false
+
+; Options: true, false
+; texture-streaming=true
+
+; streamed-atlas-physical-vram-size=0
+
+; sprite-vertex-buffer-size=1048576
+
+; max-texture-size=0
+
+; max-threads=8
+
+; 'low' and 'very-low' options are deprecated and will be migrated to 'normal'
+; 
+; Options: high, normal, low, very-low
+; graphics-quality=normal
+
+; Options: true, false
+; full-screen=true
+
+; Options: true, false
+; minimize-on-focus-loss=false
+
+; Options: true, false
+; show-smoke=true
+
+; Options: true, false
+; show-clouds=true
+
+; Options: true, false
+; show-decoratives=true
+
+; Options: true, false
+; show-item-shadows=true
+
+; Options: true, false
+; show-inserter-shadows=true
+
+; Options: true, false
+; force-opengl=false
+
+; Options: true, false
+; v-sync=true
+
+; Options: true, false
+; high-quality-animations=true
+
+; Options: true, false
+; high-quality-shadows=false
+
+; Options: true, false
+; high-quality-terrain=true
+
+; Minimum number of turrets required to turn on the turret range overdraw optimization
+; turret-overdraw-minimum-count=4
+
+; Scale at which the turret range overdraw optimization will start being applied
+; turret-overdraw-scale-threshold=0.200000
+
+; Options: true, false
+; skip-vram-detection=false
+
+; Options: true, false
+; halt-rendering-when-minimized=true
+
+; Options: true, false
+; runtime-sprite-reload=false
+
+; Options: true, false
+; full-color-depth=true
+
+; Options: true, false
+; render-in-native-resolution=true
+
+; Options: true, false
+; use-flip-presentation-model=false
+
+; Options: true, false
+; debug-api=false
+
+; Options: true, false
+; discard-buffers-on-begin-frame=true
+
+; Options: all, high, medium, low
+; video-memory-usage=high
+
+; Options: none, high-quality, low-quality
+; texture-compression-level=high-quality
+
+; Options: true, false
+; compress-virtual-atlas=true
+
+; Options: copy, copy-sequential, flip, flip-discard
+; dxgi-presentation-model=copy
+
+; Options: none, flush, wait-for-vblank, flush-and-wait-for-vblank
+; dxgi-action-before-present=none
+
+; relevant only for flip presentation models
+; 
+; Options: true, false
+; dxgi-allow-tearing=false
+
+; Options: false, true, auto
+; dxgi-flip-do-not-wait=false
+
+; Options: true, false
+; dxgi-present-restart=false
+
+; dxgi-swap-chain-buffer-count=0
+
+; dxgi-max-frame-latency=0
+
+; dxgi-adapter-index=-1
+
+; max-sprite-loading-threads=32
+
+; Options: true, false
+; gpu-accelerated-compression=true
+
+; Options: true, false
+; gpu-accelerated-mipmap-compression=true
+
+; Options: true, false
+; wait-until-mipmap-generation-finished=true
+
+; Options: true, false
+; check-for-unused-pixels=false
+
+; ogl-depth-buffer-bit-depth=0
+
+; Options: false, true, auto
+; ogl-accelerated-renderer=auto
+
+; Options: true, false
+; ogl-double-buffered=true
+
+; Set to true if mipmapped sprites render very blurry on your GPU. Limited support.
+; 
+; Options: true, false
+; legacy-gpu-no-mipmaps=false
+
+; Options: true, false
+; force-linear-magnification=false
+
+; Options: true, false
+; custom-mipmap-workaround=false
+
+; Options: true, false
+; buffer-rename-workaround=false
+
+; Comma separated list of OpenGL extensions that should not be used (for example: ARB_copy_image,KHR_debug)
+; disabled-opengl-extensions=
+
+

0.17/files/docker-entrypoint.sh

@@ -37,7 +37,7 @@ if [[ $NRTMPSAVES -gt 0 ]]; then
   rm -f "$SAVES"/*.tmp.zip
 fi
 
-if [[ ${UPDATE_MODS_ON_START:-} ]]; then
+if [[ ${UPDATE_MODS_ON_START:-} == "true" ]]; then
   ./docker-update-mods.sh
 fi
 
@@ -53,6 +53,8 @@ else
   SU_EXEC=""
 fi
 
+sed -i '/write-data=/c\write-data=\/factorio/' /opt/factorio/config/config.ini
+
 NRSAVES=$(find -L "$SAVES" -iname \*.zip -mindepth 1 | wc -l)
 if [[ $GENERATE_NEW_SAVE != true && $NRSAVES ==  0 ]]; then
     GENERATE_NEW_SAVE=true

0.17/files/update-mods.sh

@@ -32,19 +32,20 @@ update_mod()
   MOD_INFO_URL="$MOD_BASE_URL/api/mods/$MOD_NAME"
   MOD_INFO_JSON=$(curl --silent "$MOD_INFO_URL")
 
+  if ! echo "$MOD_INFO_JSON" | jq -e .name >/dev/null; then
+    print_success "  Custom mod not on $MOD_BASE_URL, skipped."
+    return 0
+  fi
+
   MOD_INFO=$(echo "$MOD_INFO_JSON" | jq -j --arg version "$FACTORIO_VERSION" ".releases|reverse|map(select(.info_json.factorio_version as \$mod_version | \$version | startswith(\$mod_version)))[0]|.file_name, \";\", .download_url, \";\", .sha1")
 
   MOD_FILENAME=$(echo "$MOD_INFO" | cut -f1 -d";")
   MOD_URL=$(echo "$MOD_INFO" | cut -f2 -d";")
   MOD_SHA1=$(echo "$MOD_INFO" | cut -f3 -d";")
 
-  if [[ -z $MOD_URL ]]; then
-    return 1
-  fi
-
   if [[ $MOD_FILENAME == null ]]; then
     print_failure "  Not compatible with version"
-    return 1
+    return 0
   fi
 
   if [[ -f $MOD_DIR/$MOD_FILENAME ]]; then

0.18/Dockerfile

@@ -1,4 +1,4 @@
-FROM frolvlad/alpine-glibc:alpine-3.9
+FROM frolvlad/alpine-glibc:alpine-3.11
 
 LABEL maintainer="https://github.com/factoriotools/factorio-docker"
 
@@ -9,8 +9,8 @@ ARG PGID=845
 
 ENV PORT=34197 \
     RCON_PORT=27015 \
-    VERSION=0.18.7 \
-    SHA1=1621f4fcd729b3f7893d8a0a63fe70f5ffd67fb9 \
+    VERSION=0.18.26 \
+    SHA1=ef57d5e65158c4035177f8cdce5303266618bee3 \
     SAVES=/factorio/saves \
     CONFIG=/factorio/config \
     MODS=/factorio/mods \
@@ -19,6 +19,7 @@ ENV PORT=34197 \
     PUID="$PUID" \
     PGID="$PGID"
 
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
 RUN set -ox pipefail \
     && archive="/tmp/factorio_headless_x64_$VERSION.tar.xz" \
     && mkdir -p /opt /factorio \
@@ -29,18 +30,14 @@ RUN set -ox pipefail \
     && tar xf "$archive" --directory /opt \
     && chmod ugo=rwx /opt/factorio \
     && rm "$archive" \
-    && 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 \
+    && mkdir -p /opt/factorio/config/ \
     && addgroup -g "$PGID" -S "$GROUP" \
     && adduser -u "$PUID" -G "$GROUP" -s /bin/sh -SDH "$USER" \
     && chown -R "$USER":"$GROUP" /opt/factorio /factorio
 
+COPY files/*.sh /
+COPY files/config.ini /opt/factorio/config/config.ini
+
 VOLUME /factorio
-
 EXPOSE $PORT/udp $RCON_PORT/tcp
-
-COPY files/ /
-
 ENTRYPOINT ["/docker-entrypoint.sh"]

0.18/files/config.ini

@@ -0,0 +1,755 @@
+; version=8
+; This is INI file : https://en.wikipedia.org/wiki/INI_file#Format 
+; Semicolons (;) at the beginning of the line indicate a comment. Comment lines are ignored.
+[path]
+read-data=__PATH__executable__/../../data
+write-data=__PATH__executable__/../..
+
+[general]
+locale=
+
+[other]
+; Options: true, false
+; verbose-logging=false
+
+; Options: true, false
+; log-saving-statistics=false
+
+; autosave-interval=5
+
+; autosave-slots=3
+
+; In ticks
+; minimum-latency-in-multiplayer=0
+
+; In seconds
+; multiplayer-initial-connection-timeout=10
+
+; port=34197
+
+; max-map-preview-chunk-side=64
+
+; max-map-preview-threads=7
+
+; In bytes
+; max-multiplayer-script-reload-size=1048576
+
+; Options: true, false
+; enable-steam-networking=true
+
+; proxy=
+
+; proxy-username=
+
+; proxy-password=
+
+; Options: true, false
+; check-updates=true
+
+; Options: true, false
+; enable-experimental-updates=false
+
+; Options: true, false
+; enable-new-mods=true
+
+; Options: true, false
+; use-mod-settings-per-save=true
+
+; Options: true, false
+; disable-minimal-mode=false
+
+; Options: true, false
+; disable-blueprint-storage=false
+
+; Disables tracking which mod created/changed what prototype. Mainly for faster startup during development.
+; 
+; Options: true, false
+; disable-prototype-history=false
+
+; Print a warning for all prototype values that were not accessed.
+; 
+; Options: true, false
+; check-unused-prototype-data=false
+
+; Cache data stage prototype data for faster startup. Experimental.
+; 
+; Options: true, false
+; cache-prototype-data=false
+
+; Options: true, false
+; enable-razer-chroma-support=true
+
+; Options: true, false
+; enable-logitech-led-support=true
+
+; Options: true, false
+; enable-crash-log-uploading=true
+
+; Options: true, false
+; enable-heap-validation=true
+
+; Options: true, false
+; enable-threaded-message-pump=true
+
+; Options: true, false
+; enable-taskbar-animation=true
+
+; Does nothing on Windows
+; 
+; Options: true, false
+; non-blocking-saving=false
+
+; Related to MacOS
+; 
+; Options: true, false
+; discard-mouse-events-when-accessibility-zoomed=false
+
+; Options: true, false
+; enable-blueprint-storage-cloud-sync=false
+
+; Options: true, false
+; force-enable-factorio-version-check=false
+
+; Options: true, false
+; bring-window-to-top-on-click=true
+
+; Options: fast, maximum
+; multiplayer-compression-level=fast
+
+; Options: none, fast, maximum
+; autosave-compression-level=fast
+
+; Socket to host RCON on when lauching MP server from the menu.
+; local-rcon-socket=0.0.0.0:0
+
+; Password for RCON when launching MP server from the menu.
+; local-rcon-password=
+
+
+[interface]
+; Options: true, false
+; automatic-ui-scale=true
+
+; custom-ui-scale=1.000000
+
+; tooltip-delay=0.040000
+
+; entity-tooltip-delay=0.000000
+
+; tooltip-offset=20
+
+; output-console-delay=1200
+
+; train-stop-label-angle=0.085526
+
+; active-quick-bars=2
+
+; shortcut-bar-rows=2
+
+; Options: true, false
+; autosort-inventory=true
+
+; Options: true, false
+; research-finished-stops-game=false
+
+; Options: true, false
+; use-item-groups=true
+
+; Options: true, false
+; use-item-subgroups=true
+
+; Options: true, false
+; use-version-filter-in-browse-games-gui=true
+
+; Options: true, false
+; use-version-filter-in-install-mods-gui=true
+
+; Options: true, false
+; play-sound-for-chat-messages=true
+
+; Options: true, false
+; fuzzy-search-enabled=false
+
+; Options: true, false
+; pick-ghost-cursor=false
+
+; Options: true, false
+; show-minimap=true
+
+; Options: true, false
+; show-tips-and-tricks=true
+
+; Options: true, false
+; show-tutorial-notifications=true
+
+; Options: true, false
+; show-turret-radius-when-blueprinting=false
+
+; Options: true, false
+; show-item-labels-in-cursor=true
+
+; Options: true, false
+; show-rail-block-visualization=true
+
+; Options: true, false
+; show-missing-logistic-network-icon=true
+
+; Options: true, false
+; show-interaction-indications=true
+
+; Options: true, false
+; show-grid-when-paused=true
+
+; Options: true, false
+; show-inserter-arrows-when-selected=true
+
+; Options: true, false
+; show-inserter-arrows-when-detailed-info-is-on=false
+
+; Options: true, false
+; show-pump-arrows-when-detailed-info-is-on=true
+
+; Options: true, false
+; show-mining-drill-arrows-when-detailed-info-is-on=true
+
+; Options: true, false
+; show-combinator-settings-when-detailed-info-is-on=false
+
+; Options: true, false
+; entity-tooltip-on-the-side=true
+
+; Options: true, false
+; show-mod-owners-in-tooltips=true
+
+; Options: true, false
+; show-descriptions-in-tooltips=true
+
+; Options: true, false
+; show-total-raw-in-recipe-tooltips=true
+
+; debug-font-size=18
+
+; train-visualization-length=5
+
+
+[sound]
+; master-volume=0.800000
+
+; music-volume=0.500000
+
+; game-effects-volume=0.700000
+
+; gui-effects-volume=0.600000
+
+; walking-sound-volume=0.250000
+
+; environment-sounds-volume=0.550000
+
+; alerts-volume=0.500000
+
+; wind-volume=0.350000
+
+; audible-distance=40.000000
+
+; environment-audible-distance=30.000000
+
+; maximum-environment-sounds=50
+
+; active-gui-volume-modifier=0.800000
+
+; active-gui-environment-volume-modifier=0.400000
+
+; The maximum volume allowed for any sound.
+; maximum-volume=2.000000
+
+; ambient-music-pause-mean-seconds=45.000000
+
+; ambient-music-pause-variance-seconds=30.000000
+
+; Options: main-tracks-only, interleave-main-tracks-with-interludes, randomize-all
+; ambient-music-mode=interleave-main-tracks-with-interludes
+
+; zoom-audible-distance-coefficient=0.500000
+
+; zoom-volume-coefficient=0.750000
+
+
+[map-view]
+; Options: true, false
+; show-logistic-network=false
+
+; Options: true, false
+; show-electric-network=false
+
+; Options: true, false
+; show-turret-range=false
+
+; Options: true, false
+; show-pollution=true
+
+; Options: true, false
+; show-networkless-logistic-members=false
+
+; Options: true, false
+; show-train-station-names=true
+
+; Options: true, false
+; show-player-names=true
+
+; Options: true, false
+; show-non-standard-map-info=false
+
+
+[debug]
+; force=enemy
+
+; Options: true, false
+; capture-perf-statistics=false
+
+; Options: always, debug, never
+; show-fps=debug
+
+; Options: always, debug, never
+; show-detailed-info=debug
+
+; Options: always, debug, never
+; show-time-usage=debug
+
+; Options: always, debug, never
+; show-gpu-time-usage=debug
+
+; Options: always, debug, never
+; show-sprite-counts=never
+
+; Options: always, debug, never
+; show-lua-object-statistics=never
+
+; Options: always, debug, never
+; show-heat-buffer-info=never
+
+; Options: always, debug, never
+; show-multiplayer-waiting-icon=debug
+
+; Options: always, debug, never
+; show-multiplayer-statistics=debug
+
+; Options: always, debug, never
+; show-multiplayer-selection-rectangles=never
+
+; Options: always, debug, never
+; show-debug-info-in-tooltips=debug
+
+; Options: always, debug, never
+; hide-mod-guis=never
+
+; Options: always, debug, never
+; show-tile-grid=never
+
+; Options: always, debug, never
+; show-collision-rectangles=never
+
+; Options: always, debug, never
+; show-selection-rectangles=never
+
+; Options: always, debug, never
+; show-render-rectangles=never
+
+; Options: always, debug, never
+; show-entity-positions=never
+
+; Options: always, debug, never
+; show-entity-velocities=never
+
+; Options: always, debug, never
+; show-selected-entity-advanced-tiles=never
+
+; Options: always, debug, never
+; show-selected-input-transport-belts=never
+
+; Options: always, debug, never
+; show-paths=never
+
+; Options: always, debug, never
+; show-path-requests=never
+
+; Options: always, debug, never
+; show-next-waypoint-bb=never
+
+; Options: always, debug, never
+; show-target=never
+
+; Options: always, debug, never
+; show-unit-group-info=never
+
+; Options: always, debug, never
+; show-unit-behavior-info=never
+
+; Options: always, debug, never
+; show-pathfinder-fringe=never
+
+; Options: always, debug, never
+; show-path-cache=never
+
+; Options: always, debug, never
+; show-path-cache-paths=never
+
+; Options: always, debug, never
+; show-rail-paths=never
+
+; Options: always, debug, never
+; show-rolling-stock-count=never
+
+; Options: always, debug, never
+; show-rail-connections=never
+
+; Options: always, debug, never
+; show-rail-joints=never
+
+; Options: always, debug, never
+; show-rail-signal-states=never
+
+; Options: always, debug, never
+; show-rail-segment-collision-boxes=never
+
+; Options: always, debug, never
+; show-train-stop-point=never
+
+; Options: always, debug, never
+; show-train-braking-distance=never
+
+; Options: always, debug, never
+; show-train-signals=never
+
+; Options: always, debug, never
+; show-train-repathing=never
+
+; Options: always, debug, never
+; show-network-connected-entities=never
+
+; Options: always, debug, never
+; show-circuit-network-numbers=never
+
+; Options: always, debug, never
+; show-energy-sources-networks=never
+
+; Options: always, debug, never
+; show-active-state=never
+
+; Options: always, debug, never
+; show-wakeup-lists=never
+
+; Options: always, debug, never
+; show-transport-lines=never
+
+; Options: always, debug, never
+; show-transport-line-gaps=never
+
+; Options: always, debug, never
+; show-pollution-values=never
+
+; Options: always, debug, never
+; show-active-entities-on-chunk-counts=never
+
+; Options: always, debug, never
+; show-active-chunks=never
+
+; Options: always, debug, never
+; show-polluted-chunks=never
+
+; Options: always, debug, never
+; hide-chart-tags=never
+
+; Options: always, debug, never
+; show-enemy-expansion-candidate-chunks=never
+
+; Options: always, debug, never
+; show-enemy-expansion-candidate-chunk-values=never
+
+; Options: always, debug, never
+; show-bad-attack-chunks=never
+
+; Options: always, debug, never
+; show-tile-variations=never
+
+; Options: always, debug, never
+; show-raw-tile-transitions=never
+
+; Options: always, debug, never
+; show-fluid-box-fluid-info=never
+
+; Options: always, debug, never
+; show-environment-sound-info=never
+
+; Options: always, debug, never
+; show-environment-sound-area=never
+
+; Options: always, debug, never
+; show-selected-entity-audible-range=never
+
+; Options: always, debug, never
+; show-recently-played-sound-info=never
+
+; Options: always, debug, never
+; show-logistic-robot-targets=never
+
+; Options: always, debug, never
+; show-logistic-robots-on-map=never
+
+; Options: always, debug, never
+; show-recipe-icons-on-map=never
+
+; Options: always, debug, never
+; show-player-robots=never
+
+; Options: always, debug, never
+; show-fire-info=never
+
+; Options: always, debug, never
+; show-sticker-info=never
+
+; Options: always, debug, never
+; show-decorative-names=never
+
+; Options: always, debug, never
+; show-decorative-collision-rectangles=never
+
+; Options: always, debug, never
+; allow-increased-zoom=never
+
+; Options: always, debug, never
+; show-chunk-components=never
+
+
+[multiplayer-lobby]
+; name=
+
+; description=
+
+; Options: true, false
+; visibility-public=true
+
+; Options: true, false
+; visibility-steam=true
+
+; Options: true, false
+; visibility-lan=true
+
+; max-players=0
+
+; Options: true, false
+; ignore-player-limit-when-returning=false
+
+; max-upload-in-kilobytes-per-second=0
+
+; max-upload-slots=5
+
+; password=
+
+; tag-list=
+
+; afk-auto-kick=0
+
+; Options: true, false, admins-only
+; allowed-commands=admins-only
+
+; Options: true, false
+; only-admins-can-pause=true
+
+; Options: true, false
+; autosave-only-on-server=true
+
+; Options: true, false
+; non-blocking-saving=true
+
+; Options: true, false
+; verify-user-identity=true
+
+; Options: true, false
+; enable-whitelist=false
+
+
+[graphics]
+; lights-render-quality=0.250000
+
+; Default preferred display index should force finding primary monitor
+; preferred-display-index=255
+
+; screenshots-threads-count=8
+
+; cache-sprite-atlas-count=1
+
+; Options: true, false
+; cache-sprite-atlas=false
+
+; Options: true, false
+; compress-sprite-atlas-cache=false
+
+; Options: true, false
+; texture-streaming=true
+
+; streamed-atlas-physical-vram-size=0
+
+; sprite-vertex-buffer-size=1048576
+
+; max-texture-size=0
+
+; max-threads=8
+
+; 'low' and 'very-low' options are deprecated and will be migrated to 'normal'
+; 
+; Options: high, normal, low, very-low
+; graphics-quality=normal
+
+; brightness=0
+
+; contrast=0
+
+; saturation=100
+
+; Options: true, false
+; full-screen=true
+
+; Options: true, false
+; minimize-on-focus-loss=false
+
+; Options: true, false
+; show-smoke=true
+
+; Options: true, false
+; show-clouds=true
+
+; Options: true, false
+; show-decoratives=true
+
+; Options: true, false
+; show-particles=true
+
+; Options: true, false
+; show-item-shadows=true
+
+; Options: true, false
+; show-inserter-shadows=true
+
+; Options: true, false
+; show-animated-water=true
+
+; Options: true, false
+; show-tree-distortion=true
+
+; Options: true, false
+; force-opengl=false
+
+; Options: true, false
+; v-sync=true
+
+; Options: true, false
+; high-quality-animations=true
+
+; Options: true, false
+; high-quality-shadows=false
+
+; Options: true, false
+; high-quality-terrain=true
+
+; Minimum number of turrets required to turn on the turret range overdraw optimization
+; turret-overdraw-minimum-count=4
+
+; Scale at which the turret range overdraw optimization will start being applied
+; turret-overdraw-scale-threshold=0.200000
+
+; Options: true, false
+; skip-vram-detection=false
+
+; Options: true, false
+; halt-rendering-when-minimized=true
+
+; Options: true, false
+; runtime-sprite-reload=false
+
+; Options: true, false
+; full-color-depth=true
+
+; Options: true, false
+; render-in-native-resolution=true
+
+; Options: true, false
+; use-flip-presentation-model=false
+
+; Options: true, false
+; debug-api=false
+
+; Options: true, false
+; discard-buffers-on-begin-frame=true
+
+; Options: all, high, medium, low
+; video-memory-usage=high
+
+; Options: none, high-quality, low-quality
+; texture-compression-level=high-quality
+
+; Options: true, false
+; compress-virtual-atlas=true
+
+; Options: copy, copy-sequential, flip, flip-discard
+; dxgi-presentation-model=copy
+
+; Options: none, flush, wait-for-vblank, flush-and-wait-for-vblank
+; dxgi-action-before-present=none
+
+; relevant only for flip presentation models
+; 
+; Options: true, false
+; dxgi-allow-tearing=false
+
+; Options: false, true, auto
+; dxgi-flip-do-not-wait=false
+
+; Options: true, false
+; dxgi-present-restart=false
+
+; dxgi-swap-chain-buffer-count=0
+
+; dxgi-max-frame-latency=0
+
+; dxgi-adapter-index=-1
+
+; max-sprite-loading-threads=32
+
+; Options: true, false
+; gpu-accelerated-compression=true
+
+; Options: true, false
+; gpu-accelerated-mipmap-compression=true
+
+; Options: true, false
+; wait-until-mipmap-generation-finished=true
+
+; Options: true, false
+; check-for-unused-pixels=false
+
+; ogl-depth-buffer-bit-depth=0
+
+; Options: false, true, auto
+; ogl-accelerated-renderer=auto
+
+; Options: true, false
+; ogl-double-buffered=true
+
+; Set to true if mipmapped sprites render very blurry on your GPU. Limited support.
+; 
+; Options: true, false
+; legacy-gpu-no-mipmaps=false
+
+; Options: true, false
+; force-linear-magnification=false
+
+; Options: true, false
+; custom-mipmap-workaround=false
+
+; Options: true, false
+; buffer-rename-workaround=false
+
+; Comma separated list of OpenGL extensions that should not be used (for example: ARB_copy_image,KHR_debug)
+; disabled-opengl-extensions=
+
+

0.18/files/docker-entrypoint.sh

@@ -37,7 +37,7 @@ if [[ $NRTMPSAVES -gt 0 ]]; then
   rm -f "$SAVES"/*.tmp.zip
 fi
 
-if [[ ${UPDATE_MODS_ON_START:-} ]]; then
+if [[ ${UPDATE_MODS_ON_START:-} == "true" ]]; then
   ./docker-update-mods.sh
 fi
 
@@ -53,6 +53,8 @@ else
   SU_EXEC=""
 fi
 
+sed -i '/write-data=/c\write-data=\/factorio/' /opt/factorio/config/config.ini
+
 NRSAVES=$(find -L "$SAVES" -iname \*.zip -mindepth 1 | wc -l)
 if [[ $GENERATE_NEW_SAVE != true && $NRSAVES ==  0 ]]; then
     GENERATE_NEW_SAVE=true

0.18/files/update-mods.sh

@@ -32,19 +32,20 @@ update_mod()
   MOD_INFO_URL="$MOD_BASE_URL/api/mods/$MOD_NAME"
   MOD_INFO_JSON=$(curl --silent "$MOD_INFO_URL")
 
+  if ! echo "$MOD_INFO_JSON" | jq -e .name >/dev/null; then
+    print_success "  Custom mod not on $MOD_BASE_URL, skipped."
+    return 0
+  fi
+
   MOD_INFO=$(echo "$MOD_INFO_JSON" | jq -j --arg version "$FACTORIO_VERSION" ".releases|reverse|map(select(.info_json.factorio_version as \$mod_version | \$version | startswith(\$mod_version)))[0]|.file_name, \";\", .download_url, \";\", .sha1")
 
   MOD_FILENAME=$(echo "$MOD_INFO" | cut -f1 -d";")
   MOD_URL=$(echo "$MOD_INFO" | cut -f2 -d";")
   MOD_SHA1=$(echo "$MOD_INFO" | cut -f3 -d";")
 
-  if [[ -z $MOD_URL ]]; then
-    return 1
-  fi
-
   if [[ $MOD_FILENAME == null ]]; then
     print_failure "  Not compatible with version"
-    return 1
+    return 0
   fi
 
   if [[ -f $MOD_DIR/$MOD_FILENAME ]]; then

README.md

@@ -1,6 +1,6 @@
 # Factorio [![Build Status](https://travis-ci.org/factoriotools/factorio-docker.svg?branch=master)](https://travis-ci.org/factoriotools/factorio-docker) ![Updater status](https://img.shields.io/endpoint?label=Updater%20status&logo=a&url=https%3A%2F%2Fhealthchecks.supersandro.de%2Fbadge%2F1a0a7698-445d-4e54-9e4b-f61a1544e01f%2FBO8VukOA%2Fmaintainer.shields) [![Docker Version](https://images.microbadger.com/badges/version/factoriotools/factorio.svg)](https://hub.docker.com/r/factoriotools/factorio/) [![Docker Pulls](https://img.shields.io/docker/pulls/factoriotools/factorio.svg?maxAge=600)](https://hub.docker.com/r/factoriotools/factorio/) [![Docker Stars](https://img.shields.io/docker/stars/factoriotools/factorio.svg?maxAge=600)](https://hub.docker.com/r/factoriotools/factorio/) [![Microbadger Layers](https://images.microbadger.com/badges/image/factoriotools/factorio.svg)](https://microbadger.com/images/factoriotools/factorio "Get your own image badge on microbadger.com")
 
-* `0.18.7`, `0.18`, `latest` [(0.18/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.18/Dockerfile)
+* `0.18.26`, `0.18`, `latest` [(0.18/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.18/Dockerfile)
 * `0.17.79`, `0.17`, `stable` [(0.17/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.17/Dockerfile)
 * `0.16.51`, `0.16` [(0.16/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.16/Dockerfile)
 * `0.15.40`, `0.15` [(0.15/Dockerfile)](https://github.com/factoriotools/factorio-docker/blob/master/0.15/Dockerfile)
@@ -118,22 +118,22 @@ sudo docker run -d \
   -p 34197:34197/udp \
   -p 27015:27015/tcp \
   -v /opt/factorio:/factorio \
-  -e ENABLE_SERVER_LOAD_LATEST=false \
+  -e LOAD_LATEST_SAVE=false \
   -e SAVE_NAME=replaceme \
   --name factorio \
   --restart=always \
   factoriotools/factorio
 ```
 
-To generate a new map set `ENABLE_GENERATE_NEW_MAP_SAVE=true` and specify `SAVE_NAME`:
+To generate a new map set `GENERATE_NEW_SAVE=true` and specify `SAVE_NAME`:
 
 ```shell
 sudo docker run -d \
   -p 34197:34197/udp \
   -p 27015:27015/tcp \
   -v /opt/factorio:/factorio \
-  -e ENABLE_SERVER_LOAD_LATEST=false \
-  -e ENABLE_GENERATE_NEW_MAP_SAVE=true \
+  -e LOAD_LATEST_SAVE=false \
+  -e GENERATE_NEW_SAVE=true \
   -e SAVE_NAME=replaceme \
   --name factorio \
   --restart=always \

build.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
 set -eoux pipefail
 
-if [[ -z ${1:-} ]] && [[ -n ${CI:-} ]]; then
+if [[ -z ${1:-} && -n ${CI:-} ]]; then
   echo 'Usage: ./build.sh VERSION_SHORT'
   exit 1
-elif [[ ${CI:-} == true ]] || [[ -n ${1:-} ]]; then
+elif [[ ${CI:-} == true || -n ${1:-} ]]; then
   VERSION_SHORT="$1"
 else
   VERSION_SHORT=$(find . -maxdepth 1 -type d | sort | tail -1 | grep -o "[[0-9]].[[0-9]]*")
@@ -21,13 +21,13 @@ if [[ ${TRAVIS_PULL_REQUEST:-} == true ]]; then
 else
   if [[ -n ${CI:-} ]]; then
     # we are either on master or on a tag build
-    if [[ $TRAVIS_BRANCH == master ]] || [[ $TRAVIS_BRANCH == "$VERSION" ]]; then
+    if [[ ${TRAVIS_BRANCH:-} == master || ${TRAVIS_BRANCH:-} == "$VERSION" ]]; then
       TAGS="-t $DOCKER_REPO:$VERSION -t $DOCKER_REPO:$VERSION_SHORT"
     # we are on an incremental build of a tag
     elif [[ $VERSION == "${TRAVIS_BRANCH%-*}" ]]; then
       TAGS="-t $DOCKER_REPO:$TRAVIS_BRANCH -t $DOCKER_REPO:$VERSION -t $DOCKER_REPO:$VERSION_SHORT"
-    # we build a other branch than master
-    elif [[ -n $TRAVIS_BRANCH ]]; then
+    # we build a other branch than master and exclude dependabot branches from tags cause the / is not supported by docker
+    elif [[ -n ${TRAVIS_BRANCH:-} && ! $TRAVIS_BRANCH =~ "/" ]]; then
       TAGS="-t $DOCKER_REPO:$TRAVIS_BRANCH"
     fi
   else
@@ -51,33 +51,35 @@ fi
 eval docker build . ${TAGS[@]}
 docker images
 
+# remove -1 from incremental tag
+# eg before: 0.18.24-1, after 0.18.24
 if [[ ${TRAVIS_BRANCH:-} ]]; then
   TRAVIS_BRANCH_VERSION=${TRAVIS_BRANCH%-*}
 fi
 
 # only push when:
-# latest changes where made in the folder corosponding to the version we build, we are on master and don#t build a PR.
-if [[ $(dirname "$(git diff --name-only HEAD^)") =~ $VERSION_SHORT ]] && [[ ${TRAVIS_BRANCH:-} == master ]] && [[ $TRAVIS_PULL_REQUEST_BRANCH == "" ]] ||
-  # we build a tag and we are not on master
-  [[ $VERSION == "${TRAVIS_BRANCH_VERSION:-}" ]] && [[ ${TRAVIS_PULL_REQUEST_BRANCH:-} == "" ]] ||
-  # we are not in CI
+# or we build a tag and we don't build a PR
+if [[ $VERSION == "${TRAVIS_BRANCH_VERSION:-}" && ${TRAVIS_PULL_REQUEST_BRANCH:-} == "" ]] ||
+  # or we are not in CI
   [[ -z ${CI:-} ]]; then
 
   if [[ ${CI:-} == true ]]; then
     echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
   fi
 
-  # push a tag on a branch other than master
-  if [[ -n ${TRAVIS_BRANCH:-} ]] && [[ $VERSION != "${TRAVIS_BRANCH_VERSION:-}" ]] && [[ ${TRAVIS_BRANCH:-} != "master" ]]; then
+  # push a tag on a branch other than master except dependabot branches cause docker does not support /
+  if [[ -n ${TRAVIS_BRANCH:-} && $VERSION != "${TRAVIS_BRANCH_VERSION:-}" && ${TRAVIS_BRANCH:-} != "master" && ! ${TRAVIS_BRANCH:-} =~ "/" ]]; then
     docker push "$DOCKER_REPO:$TRAVIS_BRANCH"
   fi
 
   # push an incremental tag
+  # eg 0.18.24-1
   if [[ $VERSION == "${TRAVIS_BRANCH_VERSION:-}" ]]; then
     docker push "$DOCKER_REPO:$TRAVIS_BRANCH"
   fi
 
-  if [[ -n ${TRAVIS_TAG:-} ]] || [[ -z ${CI:-} ]]; then
+  # only push on tags or when manually running the script
+  if [[ -n ${TRAVIS_TAG:-} || -z ${CI:-} ]]; then
     docker push "$DOCKER_REPO:$VERSION"
     docker push "$DOCKER_REPO:$VERSION_SHORT"
   fi

update-dockerhub-description.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# This script is licensed under MIT and was originally written by Peter Evans. You can find a copy of the MIT license next to this file.
+# The original file is available on his Github repo under the following link:
+# https://github.com/peter-evans/dockerhub-description/blob/84d38211e27bb9b9effefa718f8c734db8adc5e1/entrypoint.sh
+
+set -euo pipefail
+IFS=$'\n\t'
+
+# Set the default path to README.md
+README_FILEPATH=${README_FILEPATH:="./README.md"}
+
+# Check the file size
+if [[ $(wc -c <${README_FILEPATH}) -gt 25000 ]]; then
+  echo "File size exceeds the maximum allowed 25000 bytes"
+  exit 1
+fi
+
+# Acquire a token for the Docker Hub API
+echo "Acquiring token"
+# shellcheck disable=2089
+LOGIN_PAYLOAD="{\"username\": \"${DOCKERHUB_USERNAME}\", \"password\": \"${DOCKERHUB_PASSWORD}\"}"
+TOKEN=$(curl -s -H "Content-Type: application/json" -X POST -d "${LOGIN_PAYLOAD}" https://hub.docker.com/v2/users/login/ | jq -r .token)
+
+# Send a PATCH request to update the description of the repository
+echo "Sending PATCH request"
+REPO_URL="https://hub.docker.com/v2/repositories/${DOCKERHUB_REPOSITORY}/"
+RESPONSE_CODE=$(curl -s --write-out "%{response_code}" --output /dev/null -H "Authorization: JWT ${TOKEN}" -X PATCH --data-urlencode full_description@${README_FILEPATH} "${REPO_URL}")
+echo "Received response code: $RESPONSE_CODE"
+
+if [[ $RESPONSE_CODE -eq 200 ]]; then
+  exit 0
+else
+  exit 1
+fi