diff --git a/examples/aof7/docker-compose.yml b/examples/aof7/docker-compose.yml index e4b871a2..9f8692fc 100644 --- a/examples/aof7/docker-compose.yml +++ b/examples/aof7/docker-compose.yml @@ -4,7 +4,10 @@ services: environment: EULA: true MODPACK_PLATFORM: AUTO_CURSEFORGE - # from .env + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7 # CF_FILENAME_MATCHER: 1.2.2 diff --git a/examples/atm10/docker-compose.yml b/examples/atm10/docker-compose.yml index 5cf1201e..3cd35409 100644 --- a/examples/atm10/docker-compose.yml +++ b/examples/atm10/docker-compose.yml @@ -8,7 +8,10 @@ services: environment: EULA: true MOD_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: all-the-mods-10 # Optional: select a specific version/file diff --git a/examples/atm8/docker-compose.yml b/examples/atm8/docker-compose.yml index 016dbcbb..df556c78 100644 --- a/examples/atm8/docker-compose.yml +++ b/examples/atm8/docker-compose.yml @@ -6,7 +6,10 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 # CF_FILENAME_MATCHER: "1.1.0" diff --git a/examples/atm9/docker-compose.yml b/examples/atm9/docker-compose.yml index 1119a144..1b183747 100644 --- a/examples/atm9/docker-compose.yml +++ b/examples/atm9/docker-compose.yml @@ -6,7 +6,10 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9 # Optional: select a specific version/file diff --git a/examples/auto-cf/modpack-manifest/docker-compose.yml b/examples/auto-cf/modpack-manifest/docker-compose.yml index 459583b6..0f7d621e 100644 --- a/examples/auto-cf/modpack-manifest/docker-compose.yml +++ b/examples/auto-cf/modpack-manifest/docker-compose.yml @@ -4,7 +4,10 @@ services: environment: EULA: true MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_MODPACK_MANIFEST: /manifests/manifest.json CF_SLUG: "custom" diff --git a/examples/auto-cf/using-excludes/docker-compose.yml b/examples/auto-cf/using-excludes/docker-compose.yml index 1159bc78..e9a5e8da 100644 --- a/examples/auto-cf/using-excludes/docker-compose.yml +++ b/examples/auto-cf/using-excludes/docker-compose.yml @@ -6,40 +6,12 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/minecraft-eternal/files/4102634 - CF_EXCLUDE_MODS: | - cherished-worlds - controlling - ctm - custom-main-menu - ding - minecraft-rich-presence - enchantment-descriptions - just-enough-harvestcraft - just-enough-resources-jer - menumobs - more-overlays - mouse-tweaks - oldjavawarning - overloaded-armor-bar - reauth - thaumic-jei - tips - armor-toughness-bar - waila-harvestability - ambientsounds - biomeinfo - block-drops-jei-addon - loot-capacitor-tooltips - no-recipe-book - packmodemenu - resource-reloader - -# blockdrops - - CF_FORCE_SYNCHRONIZE: "true" MEMORY: 4G volumes: - mc-data:/data diff --git a/examples/bettermc/docker-compose.yml b/examples/bettermc/docker-compose.yml index df9ea61c..5813cda6 100644 --- a/examples/bettermc/docker-compose.yml +++ b/examples/bettermc/docker-compose.yml @@ -4,7 +4,10 @@ services: environment: EULA: true MODPACK_PLATFORM: AUTO_CURSEFORGE - # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: better-mc-fabric-bmc1 # CF_FILENAME_MATCHER: v18.5 diff --git a/examples/craftoria/docker-compose.yml b/examples/craftoria/docker-compose.yml index 7dfca0af..0d2582ff 100644 --- a/examples/craftoria/docker-compose.yml +++ b/examples/craftoria/docker-compose.yml @@ -9,10 +9,14 @@ services: EULA: true ALLOW_FLIGHT: true MOD_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: craftoria MEMORY: 8G + # TODO: replace with slugs and see if already excluded by cf-exclude-include.json CF_EXCLUDE_MODS: | 737481 363363 diff --git a/examples/curseforge-files/docker-compose.yml b/examples/curseforge-files/docker-compose.yml index d2b4d014..752b8635 100644 --- a/examples/curseforge-files/docker-compose.yml +++ b/examples/curseforge-files/docker-compose.yml @@ -4,7 +4,10 @@ services: environment: EULA: true TYPE: FORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} VERSION: 1.19.2 CURSEFORGE_FILES: | diff --git a/examples/docker-compose-rconcmd.yml b/examples/docker-compose-rconcmd.yml index 977d87e8..747a13b7 100644 --- a/examples/docker-compose-rconcmd.yml +++ b/examples/docker-compose-rconcmd.yml @@ -12,7 +12,10 @@ services: CURSEFORGE_FILES: | fabric-api chunky-pregenerator - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} # YAML Heredoc, be sure to use '|-' this will remove the first newline and final new line. # This is versus '|' that will leaving with two empty strings at top and bottom. diff --git a/examples/ftb-evolution/compose.yaml b/examples/ftb-evolution/compose.yaml index a3ef3eb8..b5e3cd99 100644 --- a/examples/ftb-evolution/compose.yaml +++ b/examples/ftb-evolution/compose.yaml @@ -9,6 +9,10 @@ services: environment: EULA: "TRUE" TYPE: AUTO_CURSEFORGE + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/ftb-evolution # This modpack includes an override client-side only mod that will prevent the server from starting. diff --git a/examples/ketting/docker-compose.yml b/examples/ketting/docker-compose.yml index 1a139a01..9094d0ad 100644 --- a/examples/ketting/docker-compose.yml +++ b/examples/ketting/docker-compose.yml @@ -5,6 +5,10 @@ services: EULA: true TYPE: KETTING VERSION: 1.20.1 + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: "${CF_API_KEY}" CURSEFORGE_FILES: https://www.curseforge.com/minecraft/mc-mods/aquaculture ports: diff --git a/examples/one-block-modded/docker-compose.yml b/examples/one-block-modded/docker-compose.yml index 90a41338..a0323c58 100644 --- a/examples/one-block-modded/docker-compose.yml +++ b/examples/one-block-modded/docker-compose.yml @@ -6,7 +6,10 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # CF_API_KEY=... must be set in .env file or as environment variable + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: one-block-modded # Modpack client zip must be manually downloaded from diff --git a/examples/pixelmon/docker-compose.yml b/examples/pixelmon/docker-compose.yml index f55119ba..59bad2a3 100644 --- a/examples/pixelmon/docker-compose.yml +++ b/examples/pixelmon/docker-compose.yml @@ -6,7 +6,11 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - CF_API_KEY: # allocate from https://console.curseforge.com/ + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key + CF_API_KEY: ${CF_API_KEY} CF_SLUG: the-pixelmon-modpack CF_FILENAME_MATCHER: "9.1.2" MEMORY: 4G diff --git a/examples/prominence2/docker-compose.yml b/examples/prominence2/docker-compose.yml index db210128..029e811a 100644 --- a/examples/prominence2/docker-compose.yml +++ b/examples/prominence2/docker-compose.yml @@ -6,7 +6,10 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg CF_FILENAME_MATCHER: "2.8.7" diff --git a/examples/rad2/compose.yaml b/examples/rad2/compose.yaml index 59e6114d..186c0021 100644 --- a/examples/rad2/compose.yaml +++ b/examples/rad2/compose.yaml @@ -7,20 +7,20 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/roguelike-adventures-and-dungeons-2 # Optional: select a specific version/file #CF_FILENAME_MATCHER: "0.2.34" CF_EXCLUDE_MODS: | - controlling creative-core default-options itemphysic-lite konkrete oauth - sound-filters - toast-control CF_FORCE_SYNCHRONIZE: "true" MEMORY: 4G volumes: diff --git a/examples/rlcraft/docker-compose.yml b/examples/rlcraft/docker-compose.yml index 7aa7be5f..5a813c4f 100644 --- a/examples/rlcraft/docker-compose.yml +++ b/examples/rlcraft/docker-compose.yml @@ -4,7 +4,10 @@ services: environment: EULA: true MODPACK_PLATFORM: AUTO_CURSEFORGE - # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: rlcraft CF_FILENAME_MATCHER: 2.9.3 diff --git a/examples/skyfactory5/compose.yml b/examples/skyfactory5/compose.yml index 42e00941..c31764bc 100644 --- a/examples/skyfactory5/compose.yml +++ b/examples/skyfactory5/compose.yml @@ -8,7 +8,10 @@ services: # CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6044634 CF_SLUG: skyfactory-5 CF_FILENAME_MATCHER: 5.0.2 - # Loads from .env file + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} MEMORY: 4G ports: diff --git a/examples/valhesia5/docker-compose.yml b/examples/valhesia5/docker-compose.yml index a52022b2..88f909a8 100644 --- a/examples/valhesia5/docker-compose.yml +++ b/examples/valhesia5/docker-compose.yml @@ -6,7 +6,11 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - CF_API_KEY: # allocate from https://console.curseforge.com/ + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key + CF_API_KEY: ${CF_API_KEY} 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 2abc1460..e013530f 100644 --- a/examples/vault-hunters-1-18-2/docker-compose.yml +++ b/examples/vault-hunters-1-18-2/docker-compose.yml @@ -6,13 +6,14 @@ services: environment: EULA: "true" MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ + # Allocate API key from https://console.curseforge.com/ + # and set in .env file making sure to double up dollar signs, such as + # CF_API_KEY=$$2a$$10$$.... + # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key CF_API_KEY: ${CF_API_KEY} CF_SLUG: vault-hunters-1-18-2 MOTD: "§4----- §2 Vault Hunters: 1.18.2 §4 -----§r\\n §4------ §e vaulthunters.gg §4------" MEMORY: 6G # 4G for base server + 2G per player - CF_EXCLUDE_MODS: | - reauth ALLOW_FLIGHT: true ENABLE_COMMAND_BLOCK: true DIFFICULTY: hard