Updated docs for finding FTB modpack ID (#1766)

.github/workflows/build-multiarch.yml

@@ -77,7 +77,7 @@ jobs:
             mcVersion: 1.12.2
           - variant: java8-multiarch
             baseImage: eclipse-temurin:8u312-b07-jre-focal
-            platforms: linux/amd64,linux/arm64
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.12.2
           - variant: java8-jdk
             baseImage: eclipse-temurin:8u312-b07-jdk-focal

.github/workflows/stale-check.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Process Stale Issues
-        uses: actions/stale@v5
+        uses: actions/stale@v6
         with:
           stale-issue-label: status/stale
           stale-pr-label: status/stale

Dockerfile

@@ -35,7 +35,7 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
-  --var version=0.10.3 --var app=mc-monitor --file {{.app}} \
+  --var version=0.11.0 --var app=mc-monitor --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \

README.md

@@ -568,8 +568,12 @@ Crucible is only available for 1.7.10, so be sure to set `VERSION=1.7.10`.
 [Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by using `-e TYPE=FTBA` (**note** the "A" at the end of the type). This server type will automatically take care of downloading and installing the modpack and appropriate version of Forge, so the `VERSION` does not need to be specified.
 
 ### Environment Variables:
-- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and hovering over the name of the modpack, [as shown here](docs/ftba-identifier-popup.png).
-- `FTB_MODPACK_VERSION_ID`: optional, the numerical Id of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by drilling into the Versions tab and hovering over the version name, [as shown here](docs/ftba-version-id-popup.png).
+- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and locating the ID in this part of the URL:
+  ```
+  https://www.feed-the-beast.com/modpacks/23-ftb-infinity-evolved-17
+                                          ^^
+  ```
+- `FTB_MODPACK_VERSION_ID`: optional, the numerical ID of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by hovering over a server file entry and grabbing [this ID in the URL](docs/ftba-version-id-popup.png).
 
 ### Upgrading
 
@@ -646,40 +650,6 @@ packwiz modpack defitions are processed before other mod definitions (`MODPACK`,
 
 > packwiz is pre-configured to only download server mods. If client-side mods are downloaded and cause issues, check your pack.toml configuration, and make sure any client-only mods are not set to `"both"`, but rather `"client"` for the side configuration item.
 
-### Known Issues: Curl 403 on Startup
-
-If the container enters a crash-loop or is otherwise rate-limited by Github, you
-will see an error similar to, `curl: (22) The requested URL returned error: 403`.
-
-Packwiz is primarily distributed through Github releases. In order to check if
-there are any new releases, this container must call Githubs API. All of the
-data that we need to check is public, but trouble happens when Github has reason
-to think these calls are a bad-actor. Like if the container gets stuck in a loop
-restarting and calls the API too fast or too many times. Simply, this container uses
-personal access tokens to tells Github that this system is built by a friendly
-human.
-
-[Manage Your Github's Personal Access Tokens](https://github.com/settings/tokens)
-
-Create a new personal access token for this container to use. This token will
-be used everytime the container is started or restarted so choose an expiration
-date that will last for as long as you plan to be operating this container
-instance. **The token cannot have any scopes.** This script doesn't need any
-scopes what-so-ever to Github and is only being used to signal to Github that
-a friendly human is requesting some data. **Do NOT give this token scopes. This
-container will refuse to use any token with scopes.**
-
-To configure server mods using a packwiz modpack and a github token, set the
-`PACKWIZ_URL` environment variable to the location of your `pack.toml` modpack
-definition and the `GH_TOKEN` to your token's secret value:
-
-    docker run -d -v /path/on/host:/data \
-        -p 25565:25565 \
-        -e TYPE=FORGE \
-        -e "PACKWIZ_URL=https://example.com/modpack/pack.toml" \
-        -e "GH_TOKEN"=ghp_chaosofrandomdigitsandletters \
-        itzg/minecraft-server
-
 ## Working with mods and plugins
 
 ### Optional plugins, mods, and config attach points

examples/docker-compose-curseforge-atm7.yaml

@@ -0,0 +1,151 @@
+version: '3.8'
+
+####################################################################
+#                         CURSEFORGE                               #
+#                                                                  #
+# Date: 20221005                                                   #
+#                                                                  #
+# Mod: All The Mods 7 0.4.32                                       #
+#                                                                  #
+# Notes: Verify that there is no EULA file in the modpack.zip      #
+#        if you do not delete it the EULA flag below will be       #
+#        overwritten when the modpack is copied.                   #
+#                                                                  #
+####################################################################
+services:
+
+####################################################################
+#                         Service Name                             #
+#                                                                  #
+# Define Service Name here. If using RCON this name will be        #
+# referenced again as RWA_RCON_HOST below.                         #
+#                                                                  #
+# Example: 'name:' or 'mc_atm6:'                                   #
+####################################################################
+  mc_atm7:
+
+####################################################################
+#                      Image & Container Name                      #
+#                                                                  #
+# Specify Image Name and Java Version. The 'image' will always be  #
+# 'itzg/minecraft-server' however the tag added to the end is      #
+# where you can specify the java version or container architecture.#
+# See readme.md for a full list.                                   #
+#                                                                  #
+# 'container_name:' This can be anything you like. This is the name#
+# that will show when you run 'docker ps' commands.                #
+####################################################################
+    image: itzg/minecraft-server
+    container_name: mc_atm7
+
+####################################################################
+#                         Server Ports                             #
+#                                                                  #
+# Specify external port.                                           #
+####################################################################
+    ports:
+      - 25565:25565
+
+####################################################################
+#                   Automatic Server Restart                       #
+#                                                                  #
+# Define a restart policy here.                                    #
+#    - 'no' = Do not restart.                                      #
+#    - 'on-failure' = Restart if container exits because an error. #
+#    - 'always' = Regardless of stop reason.                       #
+#    - 'unless-stopped' = Similar to always except if stopped.     #
+####################################################################
+    restart: unless-stopped
+
+####################################################################
+#                     Volume and Folder Access                     #
+#                                                                  #
+# This section defines what folders and volumes you want to give   #
+# this container access to. It is recommended to leaves these set  #
+# to the default values unless you know what you are doing.        #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+#                                                                  #
+# Specify the data volume name or directory here as well.          #
+# In this example the volume name is 'data'. When docker creates   #
+# the volume it will add what ever name you give it here to the    #
+# end of the container name specified above. In this example it    #
+# would be named 'mc_atm6_data'. If you change this be sure to     #
+# update the volume name at the bottom of this config.             #
+####################################################################
+    volumes:
+      - ./modpacks:/modpacks:ro
+      - data:/data
+
+####################################################################
+#                             EULA                                 #
+#                                                                  #
+# Accept EULA by setting to "true"                                 #
+####################################################################
+    environment:
+      EULA: "true"
+
+####################################################################
+#                       CURSEFORGE INSTALL                         #
+#                                                                  #
+# Sets install type to FORGE and specifys the zip folder name      #
+# and location of your mod pack.                                   #
+#                                                                  #
+# TYPE: Defines the install type as CURSEFORGE                     #
+#                                                                  #
+# CF_SERVER_MOD: Define where the modpack.zip is located.          #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+####################################################################
+      TYPE: CURSEFORGE
+      CF_SERVER_MOD: /modpacks/ATM7-0.4.32-server.zip
+
+####################################################################
+#                          Server Memory                           #
+#                                                                  #
+# Set Maximum amount of memory allowed for your server.            #
+####################################################################
+      MEMORY: "8G"
+
+####################################################################
+#                         Logging Options                          #
+#                                                                  #
+# Set to "true" to delete old logs                                 #
+####################################################################
+      ENABLE_ROLLING_LOGS: "true"
+
+####################################################################
+#                          Server Timezone                         #
+#                                                                  #
+# Specify server Timezone                                          #
+####################################################################
+      TZ: "America/New_York"
+
+####################################################################
+#                       Minecraft Game Options                     #
+#                                                                  #
+# List any game options you want to define here. A full list can   #
+# be found on the readme.md page on github.                        #
+####################################################################
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "easy"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      OPS: ""
+      VIEW_DISTANCE: 10
+      MAX_PLAYERS: 10
+      PVP: "false"
+      LEVEL_TYPE: "biomesoplenty"
+      MOTD: "Welcome Home"
+
+####################################################################
+#                            Volumes                               #
+#                                                                  #
+# Define data volume name here. You should leave this set to the   #
+# default.                                                         #
+####################################################################
+volumes:
+  data:

examples/docker-compose-forge-bettermcplus

@@ -0,0 +1,161 @@
+version: '3.8'
+
+####################################################################
+#                       FORGE_GENERIC_PACK                         #
+#                                                                  #
+# Date: 20221005                                                   #
+#                                                                  #
+# Mod: Better Minecraft Plus v40                                   #
+#                                                                  #
+# Game Version: 1.16.5                                             #
+#                                                                  #
+# Notes: Verify that there is no EULA file in the modpack.zip      #
+#        if you do not delete it the EULA flag below will be       #
+#        overwritten when the modpack is copied.                   #
+#                                                                  #
+####################################################################
+services:
+
+####################################################################
+#                         Service Name                             #
+#                                                                  #
+# Define Service Name here. If using RCON this name will be        #
+# referenced again as RWA_RCON_HOST below.                         #
+#                                                                  #
+# Example: 'name:' or 'mc_atm6:'                                   #
+####################################################################
+  mc_bmp:
+
+####################################################################
+#                      Image & Container Name                      #
+#                                                                  #
+# Specify Image Name and Java Version. The 'image' will always be  #
+# 'itzg/minecraft-server' however the tag added to the end is      #
+# where you can specify the java version or container architecture.#
+# See readme.md for a full list.                                   #
+#                                                                  #
+# 'container_name:' This can be anything you like. This is the name#
+# that will show when you run 'docker ps' commands.                #
+####################################################################
+    image: itzg/minecraft-server:java8
+    container_name: mc_bmp
+
+####################################################################
+#                         Server Ports                             #
+#                                                                  #
+# Specify external port.                                           #
+####################################################################
+    ports:
+      - 25565:25565
+
+####################################################################
+#                   Automatic Server Restart                       #
+#                                                                  #
+# Define a restart policy here.                                    #
+#    - 'no' = Do not restart.                                      #
+#    - 'on-failure' = Restart if container exits because an error. #
+#    - 'always' = Regardless of stop reason.                       #
+#    - 'unless-stopped' = Similar to always except if stopped.     #
+####################################################################
+    restart: unless-stopped
+
+####################################################################
+#                     Volume and Folder Access                     #
+#                                                                  #
+# This section defines what folders and volumes you want to give   #
+# this container access to. It is recommended to leaves these set  #
+# to the default values unless you know what you are doing.        #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+#                                                                  #
+# Specify the data volume name or directory here as well.          #
+# In this example the volume name is 'data'. When docker creates   #
+# the volume it will add what ever name you give it here to the    #
+# end of the container name specified above. In this example it    #
+# would be named 'mc_atm6_data'. If you change this be sure to     #
+# update the volume name at the bottom of this config.             #
+####################################################################
+    volumes:
+      - ./modpacks:/modpacks:ro
+      - data:/data
+
+####################################################################
+#                             EULA                                 #
+#                                                                  #
+# Accept EULA by setting to "true"                                 #
+####################################################################
+    environment:
+      EULA: "true"
+
+####################################################################
+#                          FORGE INSTALL                           #
+#                                                                  #
+# Sets install type to FORGE and specifys the zip folder name      #
+# and location of your mod pack.                                   #
+#                                                                  #
+# TYPE: Defines the install type as FORGE                          #
+#                                                                  #
+# VERSION: Defines the version of MC the modpack is based on.      #
+#                                                                  #
+# FORGEVERSION: Defines the version of FORGE the modpack uses.     #
+#               This can usually be found in the modpack.zip as    #
+#               installer.jar                                      #
+#                                                                  #
+# GENERIC_PACK: Define where the modpack.zip is located.           #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+####################################################################
+      TYPE: FORGE
+      VERSION: 1.16.5
+      FORGEVERSION: 36.2.39
+      GENERIC_PACK: /modpacks/Better+MC+Server+Pack+PLUS+1.16.5+v40+HF.zip
+
+####################################################################
+#                          Server Memory                           #
+#                                                                  #
+# Set Maximum amount of memory allowed for your server.            #
+####################################################################
+      MEMORY: "8G"
+
+####################################################################
+#                         Logging Options                          #
+#                                                                  #
+# Set to "true" to delete old logs                                 #
+####################################################################
+      ENABLE_ROLLING_LOGS: "true"
+
+####################################################################
+#                          Server Timezone                         #
+#                                                                  #
+# Specify server Timezone                                          #
+####################################################################
+      TZ: "America/New_York"
+
+####################################################################
+#                       Minecraft Game Options                     #
+#                                                                  #
+# List any game options you want to define here. A full list can   #
+# be found on the readme.md page on github.                        #
+####################################################################
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "easy"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      OPS: ""
+      VIEW_DISTANCE: 10
+      MAX_PLAYERS: 10
+      PVP: "false"
+      LEVEL_TYPE: "biomesoplenty"
+      MOTD: "Welcome Home"
+
+####################################################################
+#                            Volumes                               #
+#                                                                  #
+# Define data volume name here. You should leave this set to the   #
+# default.                                                         #
+####################################################################
+volumes:
+  data:

examples/docker-compose-generic-pack-atm7.yml

@@ -1,19 +0,0 @@
-version: '3.8'
-
-services:
-  mc:
-    image: itzg/minecraft-server
-    volumes:
-    - ./data:/data
-    - ./modpacks:/modpacks:ro
-    environment:
-      EULA: "true"
-      MEMORY: 2G
-      TYPE: FORGE
-      VERSION: 1.18.2
-      FORGEVERSION: 40.1.30
-      # Need to download Server-Files-0.4.13.zip and
-      # put it in modpacks directory next to this compose file
-      GENERIC_PACK: /modpacks/Server-Files-0.4.13.zip
-    ports:
-      - "25565:25565"