Fixed VERSION_FROM_MODRINTH_PROJECTS when a project has a shorter list (#3605)

.github/workflows/build-multiarch.yml

@@ -125,7 +125,7 @@ jobs:
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v5.7.0
+        uses: docker/metadata-action@v5.8.0
         with:
           # NOTE for forks: if your Docker Hub organization doesn't match your Github repo's,
           # then the use of ${{ github.repository_owner }} will need to be replaced.

Dockerfile

@@ -48,7 +48,7 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_SERVER_RUNNER_VERSION} --var app=mc-server-runner --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.48.1
+ARG MC_HELPER_VERSION=1.48.5
 ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1

docs/configuration/misc-options.md

@@ -107,11 +107,7 @@ such as:
 
 ## HTTP Proxy
 
-You may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL via the `PROXY`
-environment variable. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references
-a companion squid proxy by setting the equivalent of
-
-    -e PROXY=proxy:3128
+You may configure the use of an HTTP/HTTPS proxy by passing the proxy's "host:port" via the environment variable `PROXY`. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references a Squid proxy. The host and port can be separately passed via the environment variables `PROXY_HOST` and `PROXY_PORT`. A `|` delimited list of hosts to exclude from proxying can be passed via `PROXY_NON_PROXY_HOSTS`.
 
 ## Using "noconsole" option
 

docs/misc/healthcheck.md

@@ -7,14 +7,14 @@ CONTAINER ID        IMAGE               COMMAND             CREATED
 b418af073764        mc                  "/start"            43 seconds ago      Up 41 seconds (healthy)   0.0.0.0:25565->25565/tcp, 25575/tcp   mc
 ```
 
-You can also query the container's health in a script friendly way:
+You can also query the container's health in a script-friendly way:
 
 ``` shell
 > docker container inspect -f "{{.State.Health.Status}}" mc
 healthy
 ```
 
-There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a compose file, then use something like the following in the service declaration:
+There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a Compose file, then use something like the following in the service declaration:
 
 ``` yaml
 healthcheck:
@@ -24,9 +24,16 @@ healthcheck:
   retries: 20
 ```
 
-Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of healthchecks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
+Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of health checks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
 
-### Healthchecks for older versions
+The [health check in a Compose service declaration](https://docs.docker.com/reference/compose-file/services/#healthcheck) can also be disabled using:
 
-This container disables Healthchecks for Versions before b1.8 as those versions do not support any kind of server pinging.
-For more information see [Server List Ping](https://wiki.vg/Server_List_Ping#Beta_1.8_to_1.3)
+```yaml
+    healthcheck:
+      disable: true
+      test: ["NONE"]
+```
+
+### Health checks for older versions
+
+This container disables health checks for Minecraft versions before b1.8 as those versions do not support any kind of server pinging. For more information see [Server List Ping](https://minecraft.wiki/w/Java_Edition_protocol/Server_List_Ping#Beta_1.8_to_1.3).

docs/types-and-platforms/mod-platforms/auto-curseforge.md

@@ -12,6 +12,7 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
     
     Example if your key is `$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa`:
     ```yaml
+    # compose.yaml
     environment:
       CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
     ```
@@ -21,17 +22,35 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
     docker run ... -e CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
     ```
     
-    To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). `$`'s in the value still need to escaped with a second `$` and the variable needs to be referenced from the compose file, such as:
+    To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). You **do not** need to escape `$`'s with a second `$` in the `.env` file **as long as the key is wrapped in single quotes**. 
+    
+    ```
+    # .env
+    CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
+    ```
+    
+    The variable should to be referenced from the compose file, such as:
+    
     ```yaml
+    # compose.yaml
     environment:
       CF_API_KEY: ${CF_API_KEY}
     ```
     
+    The .env file should be placed in the same directory as your compose file like so:
+
+    ```
+    /minecraft-server
+    ├── .env
+    ├── compose.yaml
+    ├── /data
+    ```
+    
     To use the equivalent with `docker run` you need to specify the `.env` file explicitly:
     ```
     docker run --env-file=.env itzg/minecraft-server
     ```
-
+    
     Alternately you can use [docker secrets](https://docs.docker.com/compose/how-tos/use-secrets/) with a `CF_API_KEY_FILE` environment variable:
     ```
     service:
@@ -39,7 +58,7 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
         CF_API_KEY_FILE: /run/secrets/cf_api_key
       secrets:
         - cf_api_key
-
+    
     secrets:
       cf_api_key:
         file: cf_api_key.secret

docs/types-and-platforms/server-types/forge.md

@@ -45,6 +45,11 @@ In both of the cases above, there is no need for the `VERSION` or `FORGE_VERSION
 
     If an error occurred while installing Forge, it might be possible to resolve by temporarily setting `FORGE_FORCE_REINSTALL` to "true". Be sure to remove that variable after successfully starting the server.
 
+URLs configurable via environment variables:
+
+- `FORGE_PROMOTIONS_URL`: default is https://files.minecraftforge.net/net/minecraftforge/forge/promotions_slim.json
+- `FORGE_MAVEN_REPO_URL`: default is https://maven.minecraftforge.net
+
 ## Alternatives
 
 ### NeoForge

examples/ftba/compose.yml

@@ -12,6 +12,9 @@ services:
       # Use Pack ID from https://www.feed-the-beast.com/modpacks/119-ftb-presents-direwolf20-120?tab=about
       FTB_MODPACK_ID: "119"
 #      FTB_MODPACK_VERSION_ID: ""
+      MOTD: |
+        An FTB server running
+        %MODPACK_NAME% version %MODPACK_VERSION%
       MEMORY: 4G
     volumes:
       # use a named, managed volume for data volume

examples/skyfactory4/compose.yml

@@ -0,0 +1,16 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    environment:
+      EULA: "true"
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      CF_SLUG: skyfactory-4
+      CF_FILENAME_MATCHER: 4.2.4
+      CF_API_KEY: ${CF_API_KEY}
+      MEMORY: 3G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

files/cf-exclude-include.json

@@ -157,6 +157,7 @@
     "vanillafix",
     "visuality",
     "waila-harvestability",
+    "waila-stages",
     "wakes-reforged",
     "wawla",
     "welcome-screen",

files/modrinth-exclude-include.json

@@ -84,6 +84,7 @@
     "sorted_enchantments",
     "visuality",
     "VR-Combat",
+    "WailaStages",
     "welcomescreen",
     "YeetusExperimentus",
     "yungsmenutweaks",

scripts/start-configuration

@@ -50,7 +50,7 @@ fi
 
 if isTrue "${DEBUG_MEMORY:-false}"; then
   log "Memory usage and availability (in MB)"
-  uname -a
+  uname -parts
   free -m
 fi
 
@@ -101,21 +101,38 @@ if isTrue "${ENABLE_AUTOPAUSE}" && isTrue "${ENABLE_AUTOSTOP}"; then
     exit 1
 fi
 
+proxyArgs=()
 if [[ $PROXY ]]; then
     export http_proxy="$PROXY"
     export https_proxy="$PROXY"
-    export JAVA_TOOL_OPTIONS+="-Djava.net.useSystemProxies=true"
-    log "INFO: Giving proxy time to startup..."
-    sleep 5
+
+    IFS=":"
+    read -ra parts <<< "$PROXY"
+    IFS=" "
+    : "${PROXY_HOST=$(firstArrayElement parts)}"
+    shiftArray parts
+    : "${PROXY_PORT=$(firstArrayElement parts)}"
 fi
 
+# https://docs.oracle.com/javase/7/docs/api/java/net/doc-files/net-properties.html
+proxyArgs=()
+function addToProxyArgs() {
+  if [[ $2 ]]; then
+    proxyArgs+=("-D$1=$2")
+  fi
+}
+addToProxyArgs http.proxyHost "${PROXY_HOST:-}"
+addToProxyArgs http.proxyPort "${PROXY_PORT:-}"
+addToProxyArgs http.nonProxyHosts "${PROXY_NON_PROXY_HOSTS:-}"
+export MC_IMAGE_HELPER_OPTS+=" ${proxyArgs[*]}"
+
 function fixJavaPath() {
   # Some Docker management UIs grab all the image declared variables and present them for configuration.
-  # When upgrading images across Java versions, that creates a mismatch in PATH's expected by base image.
+  # When upgrading images across Java versions, that creates parts mismatch in PATH's expected by base image.
   if ! which java > /dev/null; then
     logError "       Your Docker provider has an annoying flaw where it"
     logError "       tries to set PATH even though the container establishes"
-    logError "       a very specific value."
+    logError "       parts very specific value."
     sleep 2
     # now find where java might be
     for d in /opt/java/openjdk/bin /usr/bin; do

scripts/start-deployFTBA

@@ -36,6 +36,12 @@ function getModLoaderVersion() {
 function getMinecraftVersion() {
   jq -r ".modPackTargets.mcVersion" ${ftbManifest}
 }
+function getModpackName() {
+  jq -r ".name" ${ftbManifest}
+}
+function getModpackVersion() {
+  jq -r ".versionName" ${ftbManifest}
+}
 
 if [[ $(getDistro) = alpine ]]; then
   logError "The FTBA installer is not supported on Alpine. Use the java8-multiarch image tag instead."
@@ -102,7 +108,9 @@ modLoader="$(getModLoaderName)"
 modLoaderVersion="$(getModLoaderVersion)"
 mcVersion=$(getMinecraftVersion)
 VERSION="$mcVersion"
-export VERSION
+MODPACK_NAME=$(getModpackName)
+MODPACK_VERSION=$(getModpackVersion)
+export VERSION MODPACK_NAME MODPACK_VERSION
 
 variants=(
   run.sh

scripts/start-deployModrinth

@@ -14,6 +14,7 @@ resultsFile=/data/.install-modrinth.env
 : "${MODRINTH_FORCE_INCLUDE_FILES=}"
 : "${MODRINTH_OVERRIDES_EXCLUSIONS=}"
 : "${MODRINTH_DEFAULT_EXCLUDE_INCLUDES=/image/modrinth-exclude-include.json}"
+: "${MODRINTH_FORCE_MODLOADER_REINSTALL:=${FORCE_MODLOADER_REINSTALL:-false}}"
 
 if [[ ! $MODRINTH_MODPACK ]]; then
   logError "MODRINTH_MODPACK must be set when using TYPE/MODPACK_PLATFORM/MOD_PLATFORM of MODRINTH"
@@ -33,6 +34,9 @@ args=(
 if [[ $MODRINTH_IGNORE_MISSING_FILES ]]; then
   args+=(--ignore-missing-files "$MODRINTH_IGNORE_MISSING_FILES")
 fi
+if isTrue "${MODRINTH_FORCE_MODLOADER_REINSTALL}"; then
+  args+=(--force-modloader-reinstall)
+fi
 
 case "${VERSION^^}" in
   LATEST)

scripts/start-utils

@@ -538,4 +538,18 @@ function buildDownloadList() {
     result+="${repoUrl}/${version}/$c"
   done
   echo "$result"
-}
+}
+
+function firstArrayElement {
+  local -n a="$1"
+  if (( ${#a[@]} )); then
+    echo "${a[0]}"
+  fi
+}
+
+function shiftArray {
+  local -n a="$1"
+  if (( ${#a[@]} )); then
+    a=("${a[@]:1}")
+  fi
+}