环境变量
警告
本页列出的变量是手动记录的，可能已过时或不准确。
所有其他文档页面都处于积极维护状态，因此请使用上方的搜索框查找所需主题。
通用选项¶
| 名称 | 描述 | 默认值 | 必需 |
|---|---|---|---|
UID |
运行的Linux用户ID | 1000 |
⬜️ |
GID |
运行的Linux组ID | 1000 |
⬜️ |
MEMORY |
镜像声明了初始和最大Java内存堆限制为1 GB。 | 1G |
⬜️ |
INIT_MEMORY |
独立设置初始堆大小 | 1G |
⬜️ |
MAX_MEMORY |
独立设置最大堆大小 | 1G |
⬜️ |
TZ |
您可以通过设置TZ环境变量来配置与您匹配的时区。
或者，您可以挂载：/etc/localtime:/etc/localtime:ro
/etc/timezone:/etc/timezone:ro
|
UTC |
⬜️ |
ENABLE_ROLLING_LOGS |
默认情况下，原版日志文件将无限增长。可以通过将此设置为true来重新配置记录器以使用滚动日志文件策略 |
false |
⬜️ |
ENABLE_JMX |
要启用远程JMX，例如用于使用VisualVM或JMC进行分析，请添加环境变量ENABLE_JMX=true | false |
⬜️ |
JMX_HOST |
如果启用了JMX，请将JMX_HOST设置为运行Docker容器的IP/主机，并添加TCP端口7091的端口转发 | |
⬜️ |
USE_AIKAR_FLAGS |
Aikar进行了一些研究，以找到GC调优的最佳JVM标志，这在更多用户同时连接时变得更为重要 | false |
⬜️ |
JVM_OPTS |
可以通过传递JVM_OPTS
环境变量将通用JVM选项传递给Minecraft服务器调用。JVM要求-XX选项在-X选项之前，因此可以在JVM_XX_OPTS
中声明这些选项。这两个变量都是以空格分隔的原始JVM参数 |
|
⬜️ |
JVM_XX_OPTS |
可以通过传递JVM_OPTS
环境变量将通用JVM选项传递给Minecraft服务器调用。JVM要求-XX选项在-X选项之前，因此可以在JVM_XX_OPTS
中声明这些选项。这两个变量都是以空格分隔的原始JVM参数 |
|
⬜️ |
JVM_DD_OPTS |
作为传递多个系统属性作为-D参数的简写，您可以改为传递以逗号分隔的name=value或name: value对列表，使用JVM_DD_OPTS。(为管理平台如Plesk提供冒号语法，这些平台不允许在值内使用=) | |
⬜️ |
EXTRA_ARGS |
通常传递给jar文件的参数(写在文件名之后的那些) | |
⬜️ |
LOG_TIMESTAMP |
要在每个日志中包含时间戳，请设置为true |
false |
⬜️ |
服务器¶
| 名称 | 描述 | 默认值 | 是否必需 |
|---|---|---|---|
TYPE
|
服务器类型 |
VANILLA
|
⬜️ |
EULA
|
你必须将此设置为true
|
|
✅ |
VERSION
|
Minecraft版本 |
LATEST
|
⬜️ |
MOTD
|
设置服务器登录消息。 |
|
⬜️ |
DIFFICULTY
|
难度级别。可用值：peaceful、easy、normal、hard
|
easy
|
⬜️ |
ICON
|
用于服务器的图标图像的URL或文件路径。它将被下载、缩放并转换为适当的格式。 |
|
⬜️ |
OVERRIDE_ICON
|
已设置的服务器图标默认不会被覆盖。将此设置为TRUE以覆盖图标。 |
FALSE
|
⬜️ |
MAX_PLAYERS
|
可以加入服务器的最大玩家数量。 |
20
|
⬜️ |
MAX_WORLD_SIZE
|
以半径表示的最大可能大小(以块为单位)。 |
|
⬜️ |
ALLOW_NETHER
|
允许玩家前往下界。 |
true
|
⬜️ |
ANNOUNCE_PLAYER_ACHIEVEMENTS
|
允许服务器在玩家获得成就时进行公告。 |
true
|
⬜️ |
ENABLE_COMMAND_BLOCK
|
启用命令方块。 |
|
⬜️ |
FORCE_GAMEMODE
|
强制玩家以默认游戏模式加入。 |
false
|
⬜️ |
GENERATE_STRUCTURES
|
定义是否生成结构(如村庄)。 |
true
|
⬜️ |
HARDCORE
|
如果设置为true，玩家死亡后将被设置为旁观者模式。 |
false
|
⬜️ |
SNOOPER_ENABLED
|
如果设置为false，服务器将不会向snoop.minecraft.net服务器发送数据。 |
true
|
⬜️ |
MAX_BUILD_HEIGHT
|
允许建造的最大高度。地形仍可能在较低的高度限制之上自然生成。 |
256
|
⬜️ |
SPAWN_ANIMALS
|
确定动物是否能够生成。 |
true
|
⬜️ |
SPAWN_MONSTERS
|
确定怪物是否会被生成。 |
true
|
⬜️ |
SPAWN_NPCS
|
确定村民是否会被生成。 |
true
|
⬜️ |
SPAWN_PROTECTION
|
设置非OP无法编辑的区域(0表示禁用)。 |
|
⬜️ |
VIEW_DISTANCE
|
设置服务器发送给客户端的世界数据量，以玩家周围的区块数(半径，非直径)为单位。它决定了服务器端视距。 |
|
⬜️ |
SEED
|
设置创建Minecraft世界的种子。如果使用负数，请确保将其用引号括起来。 |
|
⬜️ |
MODE |
Minecraft服务器默认配置为生存模式运行。你可以使用MODE来更改模式，可以选择提供标准数值或快捷值：
|
|
⬜️ |
PVP |
默认情况下，服务器创建时启用了 PVP 模式。 | true |
⬜️ |
LEVEL_TYPE |
默认情况下，会生成一个包含山丘、山谷、水等的标准世界。可以通过将LEVEL_TYPE设置为此处列出的预期类型来配置不同的世界类型。 | minecraft:default |
⬜️ |
GENERATOR_SETTINGS |
对于某些世界类型，可以使用GENERATOR_SETTINGS进一步自定义世界生成，如这里所述。 |
|
⬜️ |
LEVEL |
你可以通过使用LEVEL选项在不同的世界存档之间切换，或者使用不同的存档运行多个容器。 | world |
⬜️ |
ONLINE_MODE |
默认情况下，服务器会检查连接的玩家是否在Minecraft的账户数据库中。如果你想创建一个离线服务器，或者你的服务器没有连接到互联网，你可以禁用服务器尝试连接到minecraft.net来验证玩家。 | true |
⬜️ |
ALLOW_FLIGHT |
允许用户在生存模式下使用飞行功能，前提是他们安装了提供飞行功能的模组。 | FALSE |
⬜️ |
SERVER_NAME |
服务器名称 | |
⬜️ |
SERVER_PORT |
只有在你知道自己在做什么的情况下才更改此值。只有在使用主机网络时才需要此值，而主机网络很少使用。 | |
⬜️ |
PLAYER_IDLE_TIMEOUT |
玩家空闲超时 | |
⬜️ |
ENABLE_JMX |
启用JMX监控 | |
⬜️ |
SYNC_CHUNK_WRITES |
同步区块写入 | |
⬜️ |
ENABLE_STATUS |
启用状态 | |
⬜️ |
ENTITY_BROADCAST_RANGE_PERCENTAGE |
实体广播范围百分比 | |
⬜️ |
FUNCTION_PERMISSION_LEVEL |
数据包权限级别 | |
⬜️ |
NETWORK_COMPRESSION_THRESHOLD |
网络压缩阈值 | |
⬜️ |
OP_PERMISSION_LEVEL |
OP权限级别 | |
⬜️ |
PREVENT_PROXY_CONNECTIONS |
防止代理连接 | |
⬜️ |
USE_NATIVE_TRANSPORT |
使用 Native 传输 | |
⬜️ |
SIMULATION_DISTANCE |
模拟距离 | |
⬜️ |
EXEC_DIRECTLY |
如果你想使用颜色和交互功能将Docker附加到Minecraft服务器控制台，请设置为true。 |
false |
⬜️ |
STOP_SERVER_ANNOUNCE_DELAY |
为了在服务器关闭时给玩家时间完成他们的操作，可以将STOP_SERVER_ANNOUNCE_DELAY设置为服务器发布公告后的延迟秒数。 |
|
⬜️ |
PROXY |
你可以通过传递代理的URL来配置使用HTTP/HTTPS代理。 | false |
⬜️ |
CONSOLE |
一些较旧的Spigot版本(1.14之前)在分离stdin时需要传递--noconsole。 |
TRUE |
⬜️ |
GUI |
一些较旧的服务器会混淆并认为GUI界面已启用。 | TRUE |
⬜️ |
STOP_DURATION |
当容器收到停止信号时，Minecraft进程包装器将尝试通过RCON或控制台发送“停止”命令，并等待进程优雅结束。 | 60 |
⬜️ |
SETUP_ONLY |
如果你使用的是主机附加的数据目录，那么你可以通过将此设置为true来让镜像设置Minecraft服务器文件并在启动服务器进程之前停止。 |
false |
⬜️ |
USE_FLARE_FLAGS |
启用支持Flare分析套件所需的JVM标志。 | |
⬜️ |
USE_SIMD_FLAGS |
支持优化的SIMD操作 | false |
⬜️ |
自定义资源包¶
| 名称 | 描述 | 默认值 | 必需 |
|---|---|---|---|
RESOURCE_PACK |
自定义资源包的链接 | |
⬜️ |
RESOURCE_PACK_SHA1 |
自定义资源包的校验和 | |
⬜️ |
RESOURCE_PACK_ENFORCE |
强制客户端使用资源包 | FALSE |
⬜️ |
白名单¶
| 名称 | 描述 | 默认值 | 必需 |
|---|---|---|---|
ENABLE_WHITELIST |
启用白名单以手动管理白名单 | false |
⬜️ |
WHITELIST |
用户名和/或UUID的列表，用逗号分隔 | |
⬜️ |
WHITELIST_FILE |
指向白名单json格式文件的URL或文件路径 |
|
⬜️ |
OVERRIDE_WHITELIST |
强制在每次服务器启动时重新生成白名单 | false |
⬜️ |
RCON¶
| 名称 | 描述 | 默认值 | 是否必需 |
|---|---|---|---|
ENABLE_RCON |
启用/禁用RCON支持；但请注意，禁用RCON将移除并限制某些功能，例如交互式和彩色控制台支持。 | true |
⬜️ |
RCON_PASSWORD |
你必须更改此值 | 随机生成 |
✅ |
RCON_PORT |
RCON的端口 | 25575 |
⬜️ |
BROADCAST_RCON_TO_OPS |
设置广播-rcon-to-ops服务器属性 | false |
⬜️ |
RCON_CMDS_STARTUP |
服务器启动时执行的RCON命令。 | |
⬜️ |
RCON_CMDS_ON_CONNECT |
每当客户端连接到服务器时执行的RCON命令。 | |
⬜️ |
RCON_CMDS_FIRST_CONNECT |
第一个客户端连接到服务器时执行的RCON命令。 | |
⬜️ |
RCON_CMDS_ON_DISCONNECT |
每当客户端从服务器断开连接时执行的RCON命令。 | |
⬜️ |
RCON_CMDS_LAST_DISCONNECT |
最后一个客户端从服务器断开连接时执行的RCON命令。 | |
⬜️ |
自动暂停¶
注意
自动暂停功能与EXEC_DIRECTLY=true不兼容，两者不能同时设置。
| 名称 | 描述 | 默认值 | 是否必需 |
|---|---|---|---|
ENABLE_AUTOPAUSE |
启用自动暂停功能 | FALSE |
⬜️ |
AUTOPAUSE_TIMEOUT_EST |
描述最后一个客户端断开连接与进程暂停之间的时间 | 3600 |
⬜️ |
AUTOPAUSE_TIMEOUT_INIT |
描述服务器启动与进程暂停之间的时间，当在此期间没有客户端连接时 | 600 |
⬜️ |
AUTOPAUSE_TIMEOUT_KN |
描述端口ping(例如MOTD ping)与进程暂停之间的时间，当在此期间没有客户端连接时 | 120 |
⬜️ |
AUTOPAUSE_PERIOD |
描述处理进程暂停的守护进程状态机的周期 | 10 |
⬜️ |
AUTOPAUSE_KNOCK_INTERFACE |
描述传递给knockd守护进程的接口。如果默认接口不起作用，请在容器内运行ifconfig命令，并从其输出中获取接收传入连接的接口。传递的接口必须在容器内存在。使用回环接口(lo)可能不会产生预期结果。 | eth0 |
⬜️ |
DEBUG_AUTOPAUSE |
为自动暂停功能添加额外的调试输出 | false |
⬜️ |
自动停止¶
注意
自动停止功能与自动暂停功能不兼容，因为它们基本上会相互抵消。
| 名称 | 描述 | 默认值 | 是否必需 |
|---|---|---|---|
ENABLE_AUTOSTOP |
启用自动停止功能 | FALSE |
⬜️ |
AUTOSTOP_TIMEOUT_EST |
描述最后一个客户端断开连接与服务器停止之间的时间 | 3600 |
⬜️ |
AUTOSTOP_TIMEOUT_INIT |
描述服务器启动与服务器停止之间的时间，当在此期间没有客户端连接时 | 1800 |
⬜️ |
AUTOSTOP_PERIOD |
描述处理服务器停止的守护进程状态机的周期 | 10 |
⬜️ |
DEBUG_AUTOSTOP |
为自动停止功能添加额外的日志记录 | false |
⬜️ |
CurseForge¶
提示
更多详情和最新信息，请参阅主文档页面。
| 名称 | 描述 | 默认值 | 必需 |
|---|---|---|---|
CF_API_KEY |
你的 CurseForge (Eternal) API 密钥。 | |
✅ |
CF_PAGE_URL |
传递模组包或特定文件的页面 URL。 | |
⬜️ |
CF_SLUG |
可以提供模组包的 slug 而不是 URL。 | |
⬜️ |
CF_FILE_ID |
模组的 CurseForge 数字 ID。 | |
⬜️ |
CF_FILENAME_MATCHER |
指定一个子字符串来匹配所需的文件名。 | |
⬜️ |
CF_EXCLUDE_INCLUDE_FILE |
全局和每个模组包的排除项可以在 JSON 文件中声明，并通过此变量引用。 默认情况下，将使用与镜像捆绑的文件，但可以通过将其设置为空字符串来禁用。该文件的架构在此处记录。 |
|
⬜️ |
CF_EXCLUDE_MODS |
可以通过传递以逗号或空格分隔的项目 slug 或 ID 列表来排除模组。 | |
⬜️ |
CF_FORCE_INCLUDE_MODS |
可以通过传递以逗号或空格分隔的项目 slug 或 ID 列表来包含模组。 | |
⬜️ |
CF_FORCE_SYNCHRONIZE |
强制重新评估排除/包含项。 | |
⬜️ |
CF_SET_LEVEL_FROM |
一些模组包通过世界文件和/或模组包提供的覆盖项附带世界/保存数据。可以通过将此项设置为以下任一项来选择设置 LEVEL 为生成的保存目录：
|
|
⬜️ |
CF_PARALLEL_DOWNLOADS |
指定并行下载的模组数量。 | 4 |
⬜️ |
CF_OVERRIDES_SKIP_EXISTING |
如果设置，覆盖项中已存在于数据目录中的文件将被跳过。如果存在世界数据，则始终跳过。 | false |
⬜️ |