diff --git a/Dockerfile b/Dockerfile index 5f5a69d3..ea092b37 100644 --- a/Dockerfile +++ b/Dockerfile @@ -46,7 +46,7 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \ --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \ --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz -ARG MC_HELPER_VERSION=1.25.19 +ARG MC_HELPER_VERSION=1.25.20 ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION} RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \ | tar -C /usr/share -zxf - \ diff --git a/README.md b/README.md index 60cf83b3..6b6b4de4 100644 --- a/README.md +++ b/README.md @@ -616,6 +616,9 @@ docker run -d --name mc-ftb -e EULA=TRUE \ To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed. > **NOTES:** +> +> A CurseForge API key is **required** to use this feature. Go to their [developer console](https://console.curseforge.com/), generate an API key, and set the environment variable `CF_API_KEY`. +> > Be sure to use the appropriate [image tag for the Java version compatible with the modpack](#running-minecraft-server-on-different-java-version). > > Most modpacks require a good amount of memory, so it best to set `MEMORY` to at least "4G" since the default is only 1 GB. diff --git a/examples/atm8/docker-compose.yml b/examples/atm8/docker-compose.yml index 92a0bb9d..a9b09678 100644 --- a/examples/atm8/docker-compose.yml +++ b/examples/atm8/docker-compose.yml @@ -8,6 +8,7 @@ services: environment: EULA: "true" TYPE: AUTO_CURSEFORGE + CF_API_KEY: # allocate from https://console.curseforge.com/ CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 CF_FILENAME_MATCHER: "1.0.6" MEMORY: 4G diff --git a/examples/one-block-modded/docker-compose.yml b/examples/one-block-modded/docker-compose.yml index 6abc226a..397f27ac 100644 --- a/examples/one-block-modded/docker-compose.yml +++ b/examples/one-block-modded/docker-compose.yml @@ -8,6 +8,7 @@ services: environment: EULA: "true" TYPE: AUTO_CURSEFORGE + CF_API_KEY: # allocate from https://console.curseforge.com/ CF_PAGE_URL: "https://www.curseforge.com/minecraft/modpacks/one-block-modded/files/4136487" CF_SET_LEVEL_FROM: OVERRIDES DEBUG: "false" diff --git a/examples/pixelmon/docker-compose.yml b/examples/pixelmon/docker-compose.yml index 47afd3d6..6a990b2f 100644 --- a/examples/pixelmon/docker-compose.yml +++ b/examples/pixelmon/docker-compose.yml @@ -8,6 +8,7 @@ services: environment: EULA: "true" TYPE: AUTO_CURSEFORGE + CF_API_KEY: # allocate from https://console.curseforge.com/ CF_SLUG: the-pixelmon-modpack CF_FILENAME_MATCHER: "9.1.2" MEMORY: 4G diff --git a/examples/valhesia5/docker-compose.yml b/examples/valhesia5/docker-compose.yml index 3ece303b..7c47ddb6 100644 --- a/examples/valhesia5/docker-compose.yml +++ b/examples/valhesia5/docker-compose.yml @@ -8,6 +8,7 @@ services: environment: EULA: "true" TYPE: AUTO_CURSEFORGE + CF_API_KEY: # allocate from https://console.curseforge.com/ CF_FORCE_SYNCHRONIZE: "true" CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560 MEMORY: 4G diff --git a/examples/vault-hunters-1-18-2/docker-compose.yml b/examples/vault-hunters-1-18-2/docker-compose.yml index a9e7b15e..e2910357 100644 --- a/examples/vault-hunters-1-18-2/docker-compose.yml +++ b/examples/vault-hunters-1-18-2/docker-compose.yml @@ -8,6 +8,7 @@ services: environment: EULA: "true" TYPE: AUTO_CURSEFORGE + CF_API_KEY: # allocate from https://console.curseforge.com/ CF_SLUG: vault-hunters-1-18-2 CF_FILENAME_MATCHER: "Update-6H" MEMORY: 4G diff --git a/tests/setuponlytests/auto_curseforge/docker-compose.yml b/tests/setuponlytests/auto_curseforge/docker-compose.yml index ac9b8607..69d7b492 100644 --- a/tests/setuponlytests/auto_curseforge/docker-compose.yml +++ b/tests/setuponlytests/auto_curseforge/docker-compose.yml @@ -7,6 +7,7 @@ services: EULA: "true" SETUP_ONLY: "TRUE" TYPE: AUTO_CURSEFORGE + CF_API_KEY: ${CF_API_KEY} CF_SLUG: the-pixelmon-modpack CF_FILENAME_MATCHER: "9.1.2" # Use the image bundled one to ensure latest is being tested diff --git a/tests/setuponlytests/auto_curseforge/require.sh b/tests/setuponlytests/auto_curseforge/require.sh new file mode 100755 index 00000000..6c320cd0 --- /dev/null +++ b/tests/setuponlytests/auto_curseforge/require.sh @@ -0,0 +1 @@ +[[ $CF_API_KEY ]] || exit 1 \ No newline at end of file