Skip to content

Commit 3a678a6

Browse files
itzgitzg
authored
Clarify CF_API_KEY setup in examples (#3321)
1 parent b1128db commit 3a678a6

File tree

20 files changed

+83
-54
lines changed

20 files changed

+83
-54
lines changed

‎examples/aof7/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ services:
44
environment:
55
EULA: true
66
MODPACK_PLATFORM: AUTO_CURSEFORGE
7-
# from .env
7+
# Allocate API key from https://console.curseforge.com/
8+
# and set in .env file making sure to double up dollar signs, such as
9+
# CF_API_KEY=$$2a$$10$$....
10+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
811
CF_API_KEY: ${CF_API_KEY}
912
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7
1013
# CF_FILENAME_MATCHER: 1.2.2

‎examples/atm10/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ services:
88
environment:
99
EULA: true
1010
MOD_PLATFORM: AUTO_CURSEFORGE
11-
# allocate from https://console.curseforge.com/ and set in .env file
11+
# Allocate API key from https://console.curseforge.com/
12+
# and set in .env file making sure to double up dollar signs, such as
13+
# CF_API_KEY=$$2a$$10$$....
14+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1215
CF_API_KEY: ${CF_API_KEY}
1316
CF_SLUG: all-the-mods-10
1417
# Optional: select a specific version/file

‎examples/atm8/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# allocate from https://console.curseforge.com/ and set in .env file
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
1215
# CF_FILENAME_MATCHER: "1.1.0"

‎examples/atm9/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# allocate from https://console.curseforge.com/ and set in .env file
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9
1215
# Optional: select a specific version/file

‎examples/auto-cf/modpack-manifest/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ services:
44
environment:
55
EULA: true
66
MODPACK_PLATFORM: AUTO_CURSEFORGE
7-
# allocate from https://console.curseforge.com/ and set in .env file
7+
# Allocate API key from https://console.curseforge.com/
8+
# and set in .env file making sure to double up dollar signs, such as
9+
# CF_API_KEY=$$2a$$10$$....
10+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
811
CF_API_KEY: ${CF_API_KEY}
912
CF_MODPACK_MANIFEST: /manifests/manifest.json
1013
CF_SLUG: "custom"

‎examples/auto-cf/using-excludes/docker-compose.yml

+4-32
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,12 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# allocate from https://console.curseforge.com/ and set in .env file
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/minecraft-eternal/files/4102634
12-
CF_EXCLUDE_MODS: |
13-
cherished-worlds
14-
controlling
15-
ctm
16-
custom-main-menu
17-
ding
18-
minecraft-rich-presence
19-
enchantment-descriptions
20-
just-enough-harvestcraft
21-
just-enough-resources-jer
22-
menumobs
23-
more-overlays
24-
mouse-tweaks
25-
oldjavawarning
26-
overloaded-armor-bar
27-
reauth
28-
thaumic-jei
29-
tips
30-
armor-toughness-bar
31-
waila-harvestability
32-
ambientsounds
33-
biomeinfo
34-
block-drops-jei-addon
35-
loot-capacitor-tooltips
36-
no-recipe-book
37-
packmodemenu
38-
resource-reloader
39-
40-
# blockdrops
41-
42-
CF_FORCE_SYNCHRONIZE: "true"
4315
MEMORY: 4G
4416
volumes:
4517
- mc-data:/data

‎examples/bettermc/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ services:
44
environment:
55
EULA: true
66
MODPACK_PLATFORM: AUTO_CURSEFORGE
7-
# Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
7+
# Allocate API key from https://console.curseforge.com/
8+
# and set in .env file making sure to double up dollar signs, such as
9+
# CF_API_KEY=$$2a$$10$$....
10+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
811
CF_API_KEY: ${CF_API_KEY}
912
CF_SLUG: better-mc-fabric-bmc1
1013
# CF_FILENAME_MATCHER: v18.5

‎examples/craftoria/docker-compose.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ services:
99
EULA: true
1010
ALLOW_FLIGHT: true
1111
MOD_PLATFORM: AUTO_CURSEFORGE
12-
# allocate from https://console.curseforge.com/ and set in .env file
12+
# Allocate API key from https://console.curseforge.com/
13+
# and set in .env file making sure to double up dollar signs, such as
14+
# CF_API_KEY=$$2a$$10$$....
15+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1316
CF_API_KEY: ${CF_API_KEY}
1417
CF_SLUG: craftoria
1518
MEMORY: 8G
19+
# TODO: replace with slugs and see if already excluded by cf-exclude-include.json
1620
CF_EXCLUDE_MODS: |
1721
737481
1822
363363

‎examples/curseforge-files/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ services:
44
environment:
55
EULA: true
66
TYPE: FORGE
7-
# allocate from https://console.curseforge.com/ and set in .env file
7+
# Allocate API key from https://console.curseforge.com/
8+
# and set in .env file making sure to double up dollar signs, such as
9+
# CF_API_KEY=$$2a$$10$$....
10+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
811
CF_API_KEY: ${CF_API_KEY}
912
VERSION: 1.19.2
1013
CURSEFORGE_FILES: |

‎examples/docker-compose-rconcmd.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ services:
1212
CURSEFORGE_FILES: |
1313
fabric-api
1414
chunky-pregenerator
15-
# allocate from https://console.curseforge.com/ and set in .env file
15+
# Allocate API key from https://console.curseforge.com/
16+
# and set in .env file making sure to double up dollar signs, such as
17+
# CF_API_KEY=$$2a$$10$$....
18+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1619
CF_API_KEY: ${CF_API_KEY}
1720
# YAML Heredoc, be sure to use '|-' this will remove the first newline and final new line.
1821
# This is versus '|' that will leaving with two empty strings at top and bottom.

‎examples/ftb-evolution/compose.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ services:
99
environment:
1010
EULA: "TRUE"
1111
TYPE: AUTO_CURSEFORGE
12+
# Allocate API key from https://console.curseforge.com/
13+
# and set in .env file making sure to double up dollar signs, such as
14+
# CF_API_KEY=$$2a$$10$$....
15+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1216
CF_API_KEY: ${CF_API_KEY}
1317
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/ftb-evolution
1418
# This modpack includes an override client-side only mod that will prevent the server from starting.

‎examples/ketting/docker-compose.yml

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ services:
55
EULA: true
66
TYPE: KETTING
77
VERSION: 1.20.1
8+
# Allocate API key from https://console.curseforge.com/
9+
# and set in .env file making sure to double up dollar signs, such as
10+
# CF_API_KEY=$$2a$$10$$....
11+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
812
CF_API_KEY: "${CF_API_KEY}"
913
CURSEFORGE_FILES: https://www.curseforge.com/minecraft/mc-mods/aquaculture
1014
ports:

‎examples/one-block-modded/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# CF_API_KEY=... must be set in .env file or as environment variable
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_SLUG: one-block-modded
1215
# Modpack client zip must be manually downloaded from

‎examples/pixelmon/docker-compose.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
CF_API_KEY: # allocate from https://console.curseforge.com/
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
13+
CF_API_KEY: ${CF_API_KEY}
1014
CF_SLUG: the-pixelmon-modpack
1115
CF_FILENAME_MATCHER: "9.1.2"
1216
MEMORY: 4G

‎examples/prominence2/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# allocate from https://console.curseforge.com/ and set in .env file
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg
1215
CF_FILENAME_MATCHER: "2.8.7"

‎examples/rad2/compose.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ services:
77
environment:
88
EULA: "true"
99
MODPACK_PLATFORM: AUTO_CURSEFORGE
10-
# allocate from https://console.curseforge.com/ and set in .env file
10+
# Allocate API key from https://console.curseforge.com/
11+
# and set in .env file making sure to double up dollar signs, such as
12+
# CF_API_KEY=$$2a$$10$$....
13+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1114
CF_API_KEY: ${CF_API_KEY}
1215
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/roguelike-adventures-and-dungeons-2
1316
# Optional: select a specific version/file
1417
#CF_FILENAME_MATCHER: "0.2.34"
1518
CF_EXCLUDE_MODS: |
16-
controlling
1719
creative-core
1820
default-options
1921
itemphysic-lite
2022
konkrete
2123
oauth
22-
sound-filters
23-
toast-control
2424
CF_FORCE_SYNCHRONIZE: "true"
2525
MEMORY: 4G
2626
volumes:

‎examples/rlcraft/docker-compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ services:
44
environment:
55
EULA: true
66
MODPACK_PLATFORM: AUTO_CURSEFORGE
7-
# Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
7+
# Allocate API key from https://console.curseforge.com/
8+
# and set in .env file making sure to double up dollar signs, such as
9+
# CF_API_KEY=$$2a$$10$$....
10+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
811
CF_API_KEY: ${CF_API_KEY}
912
CF_SLUG: rlcraft
1013
CF_FILENAME_MATCHER: 2.9.3

‎examples/skyfactory5/compose.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ services:
88
# CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6044634
99
CF_SLUG: skyfactory-5
1010
CF_FILENAME_MATCHER: 5.0.2
11-
# Loads from .env file
11+
# Allocate API key from https://console.curseforge.com/
12+
# and set in .env file making sure to double up dollar signs, such as
13+
# CF_API_KEY=$$2a$$10$$....
14+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1215
CF_API_KEY: ${CF_API_KEY}
1316
MEMORY: 4G
1417
ports:

‎examples/valhesia5/docker-compose.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
CF_API_KEY: # allocate from https://console.curseforge.com/
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
13+
CF_API_KEY: ${CF_API_KEY}
1014
CF_FORCE_SYNCHRONIZE: "true"
1115
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560
1216
MEMORY: 4G

‎examples/vault-hunters-1-18-2/docker-compose.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ services:
66
environment:
77
EULA: "true"
88
MODPACK_PLATFORM: AUTO_CURSEFORGE
9-
# allocate from https://console.curseforge.com/
9+
# Allocate API key from https://console.curseforge.com/
10+
# and set in .env file making sure to double up dollar signs, such as
11+
# CF_API_KEY=$$2a$$10$$....
12+
# Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
1013
CF_API_KEY: ${CF_API_KEY}
1114
CF_SLUG: vault-hunters-1-18-2
1215
MOTD: "§4----- §2 Vault Hunters: 1.18.2 §4 -----§r\\n §4------ §e vaulthunters.gg §4------"
1316
MEMORY: 6G # 4G for base server + 2G per player
14-
CF_EXCLUDE_MODS: |
15-
reauth
1617
ALLOW_FLIGHT: true
1718
ENABLE_COMMAND_BLOCK: true
1819
DIFFICULTY: hard

0 commit comments

Comments
 (0)