diff --git a/.github/workflows/verify-pr.yml b/.github/workflows/verify-pr.yml index 113d34c5..db6d0ee2 100644 --- a/.github/workflows/verify-pr.yml +++ b/.github/workflows/verify-pr.yml @@ -7,6 +7,8 @@ on: - "*.md" - "docs/**" - "examples/**" + - "docker-compose*.yml" + - "mkdocs.yml" jobs: build: diff --git a/README.md b/README.md index 44adda88..9741f2cb 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Unless you're on a home/private LAN, you should [enable TLS access](https://docs Everything the container manages is located under the **container's** `/data` path, as shown here: -![](docs/level-vs-world.drawio.png) +![](docs/img/level-vs-world.drawio.png) > NOTE: The container path `/data` is pre-declared as a volume, so if you do nothing then it will be allocated as an anonymous volume. As such, it is subject to removal when the container is removed. @@ -601,10 +601,10 @@ The desired modpack project is specified with the `MODRINTH_PROJECT` environment - The project "slug", which is located in the URL shown here: - ![](docs/modrinth-project-slug.drawio.png) + ![](docs/img/modrinth-project-slug.drawio.png) - The project ID, which is located in the bottom of the left panel, shown here - ![](docs/modrinth-project-id.drawio.png) + ![](docs/img/modrinth-project-id.drawio.png) - The project page URL, such as . As described below, this can further be the page URL of a modpack's version page. The automatic modpack version resolving can be narrowed in a few ways: @@ -617,7 +617,7 @@ The selected version can also be narrowed to a particular mod loader by setting Instead of auto resolving, a specific version of modpack file can be specified by passing the version's page URL to `MODRINTH_PROJECT`, such as or by setting `MODRINTH_VERSION` to the version ID or number located in the Metadata section, as shown here -![](docs/modrinth-version-id.drawio.png) +![](docs/img/modrinth-version-id.drawio.png) ## Running a server with a Feed the Beast modpack @@ -631,7 +631,7 @@ Instead of auto resolving, a specific version of modpack file can be specified b 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). +- `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/img/ftba-version-id-popup.png). ### Upgrading @@ -698,7 +698,7 @@ Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as -![cf-slug](docs/cf-slug.png) +![cf-slug](docs/img/cf-slug.png) For example: ``` @@ -717,7 +717,7 @@ The latest file will be located and used by default, but if a specific version i The following shows where to get the URL to the specific file and also shows where the file ID is located: -![cf-file-id](docs/cf-file-id.png) +![cf-file-id](docs/img/cf-file-id.png) The following examples all refer to version 1.0.7 of ATM8: @@ -740,7 +740,7 @@ Global and per modpack exclusions can be declared in a JSON file and referenced Alternatively, they can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. These lists will be combined with the content of the exclude/include file, if given. A mod's project ID can be obtained from the right hand side of the project page: -![cf-project-id](docs/cf-project-id.png) +![cf-project-id](docs/img/cf-project-id.png) If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true" to ensure the exclude/includes are re-evaluated. @@ -1029,7 +1029,7 @@ docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic The following diagram shows how this option can be used in a compose deployment with a relative directory: -![](docs/world-copy-compose-project.drawio.png) +![](docs/img/world-copy-compose-project.drawio.png) ### Overwrite world on start The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start. @@ -1152,7 +1152,7 @@ The section symbol (§) and other unicode characters are automatically converted renders -![](docs/motd-example.png) +![](docs/img/motd-example.png) To produce a multi-line MOTD, you will need to double escape the newline such as diff --git a/docker-compose-mkdocs.yml b/docker-compose-mkdocs.yml new file mode 100644 index 00000000..0088846c --- /dev/null +++ b/docker-compose-mkdocs.yml @@ -0,0 +1,21 @@ +# This composition can be used to serve up the rendered mkdocs for local authoring. +# +# docker compose -f docker-compose-mkdocs.yml -p mkdocs up +# +# and then access http://localhost:8000 + +version: "3.8" + +services: + mkdocs: + build: + context: . + dockerfile: docs/Dockerfile + volumes: + - ./mkdocs.yml:/mkdocs/mkdocs.yml + - ./docs:/mkdocs/docs + command: + - serve + - --dev-addr=0.0.0.0:8000 + ports: + - "8000:8000" \ No newline at end of file diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..b6cf122d --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,10 @@ +FROM python:3.8 + +RUN pip install --upgrade pip + +WORKDIR /mkdocs + +RUN --mount=target=/build/requirements.txt,source=docs/requirements.txt \ + pip install -r /build/requirements.txt + +ENTRYPOINT ["mkdocs"] \ No newline at end of file diff --git a/docs/Going from docker run to compose.drawio.png b/docs/Going from docker run to compose.drawio.png deleted file mode 100644 index d12219b5..00000000 Binary files a/docs/Going from docker run to compose.drawio.png and /dev/null differ diff --git a/docs/cf-project-id.png b/docs/cf-project-id.png deleted file mode 100644 index ea78cddc..00000000 Binary files a/docs/cf-project-id.png and /dev/null differ diff --git a/docs/cf-slug.png b/docs/cf-slug.png deleted file mode 100644 index 08406760..00000000 Binary files a/docs/cf-slug.png and /dev/null differ diff --git a/docs/configuration/misc-options.md b/docs/configuration/misc-options.md new file mode 100644 index 00000000..9e957a12 --- /dev/null +++ b/docs/configuration/misc-options.md @@ -0,0 +1,440 @@ +### Replacing variables inside configs + +Sometimes you have mods or plugins that require configuration information that is only available at runtime. +For example if you need to configure a plugin to connect to a database, +you don't want to include this information in your Git repository or Docker image. +Or maybe you have some runtime information like the server name that needs to be set +in your config files after the container starts. + +For those cases there is the option to replace defined variables inside your configs +with environment variables defined at container runtime. + +When the environment variable `REPLACE_ENV_IN_PLACE` is set to `true` (the default), the startup script will go through all files inside the container's `/data` path and replace variables that match the container's environment variables. Variables can instead (or in addition to) be replaced in files sync'ed from `/plugins`, `/mods`, and `/config` by setting `REPLACE_ENV_DURING_SYNC` to `true` (defaults to `false`). + +Variables that you want to replace need to be declared inside curly brackets and prefixed with a dollar sign, such as `${CFG_YOUR_VARIABLE}`, which is same as many scripting languages. + +You can also change `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_", to limit which environment variables are allowed to be used. For example, with "CFG_" as the prefix, the variable `${CFG_DB_HOST}` would be subsituted, but not `${DB_HOST}`. + +If you want to use a file's content for value, such as when using secrets mounted as files, declare the placeholder named like normal in the file and declare an environment variable named the same but with the suffix `_FILE`. + +For example, a `my.cnf` file could contain: + +``` +[client] +password = ${CFG_DB_PASSWORD} +``` + +...a secret declared in the compose file with: +```yaml +secrets: + db_password: + external: true +``` + +...and finally the environment variable would be named with a `_FILE` suffix and point to the mounted secret: +```yaml + environment: + CFG_DB_PASSWORD_FILE: /run/secrets/db_password +``` + +Variables will be replaced in files with the following extensions: +`.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`. + +Specific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`. + +Paths can be excluded by listing them in the variable `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. Path +excludes are recursive. Here is an example: +``` +REPLACE_ENV_VARIABLES_EXCLUDE_PATHS="/data/plugins/Essentials/userdata /data/plugins/MyPlugin" +``` + +Here is a full example where we want to replace values inside a `database.yml`. + +```yml + +--- +database: + host: ${CFG_DB_HOST} + name: ${CFG_DB_NAME} + password: ${CFG_DB_PASSWORD} +``` + +This is how your `docker-compose.yml` file could look like: + +```yml +version: "3.8" +# Other docker-compose examples in /examples + +services: + minecraft: + image: itzg/minecraft-server + ports: + - "25565:25565" + volumes: + - "mc:/data" + environment: + EULA: "TRUE" + ENABLE_RCON: "true" + RCON_PASSWORD: "testing" + RCON_PORT: 28016 + # enable env variable replacement + REPLACE_ENV_VARIABLES: "TRUE" + # define an optional prefix for your env variables you want to replace + ENV_VARIABLE_PREFIX: "CFG_" + # and here are the actual variables + CFG_DB_HOST: "http://localhost:3306" + CFG_DB_NAME: "minecraft" + CFG_DB_PASSWORD_FILE: "/run/secrets/db_password" + +volumes: + mc: + rcon: + +secrets: + db_password: + file: ./db_password +``` + +### Patching existing files + +JSON path based patches can be applied to one or more existing files by setting the variable `PATCH_DEFINITIONS` to the path of a directory that contains one or more [patch definition json files](https://github.com/itzg/mc-image-helper#patchdefinition) or a [patch set json file](https://github.com/itzg/mc-image-helper#patchset). + +Variable placeholders in the patch values can be restricted by setting `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_". + +The following example shows a patch-set file were various fields in the `paper.yaml` configuration file can be modified and added: + +```json +{ + "patches": [ + { + "file": "/data/paper.yml", + "ops": [ + { + "$set": { + "path": "$.verbose", + "value": true + } + }, + { + "$set": { + "path": "$.settings['velocity-support'].enabled", + "value": "${CFG_VELOCITY_ENABLED}", + "value-type": "bool" + } + }, + { + "$put": { + "path": "$.settings", + "key": "my-test-setting", + "value": "testing" + } + } + ] + } + ] +} +``` + +> **NOTES:** Only JSON and Yaml files can be patched at this time. TOML support is planned to be added next. Removal of comments and other cosmetic changes will occur when patched files are processed. + +### Running with a custom server JAR + +If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server +JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file. + +If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As +such, if you need to upgrade or re-download the JAR, then you will need to stop the container, +remove the file from the container's `/data` directory, and start again. + +### Force re-download of the server file + +For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set +`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for +the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line. + +For example, with PaperSpigot, it would look something like this: + +``` +docker run -d -v /path/on/host:/data \ + -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server +``` + +### Running as alternate user/group ID + +By default, the container will switch to user ID 1000 and group ID 1000; +however, you can override those values by setting `UID` and/or `GID` as environmental entries, during the `docker run` command. + + -e UID=1234 + -e GID=1234 + +The container will also skip user switching if the `--user`/`-u` argument +is passed to `docker run`. + +### Memory Limit + +By default, the image declares an initial and maximum Java memory-heap limit of 1 GB. There are several ways to adjust the memory settings: + +- `MEMORY`: "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`) memory heap settings of the JVM +- `INIT_MEMORY`: independently sets the initial heap size +- `MAX_MEMORY`: independently sets the max heap size + +The values of all three are passed directly to the JVM and support format/units as `[g|G|m|M|k|K]`. For example: + + -e MEMORY=2G + +To let the JVM calculate the heap size from the container declared memory limit, unset `MEMORY` with an empty value, such as `-e MEMORY=""`. By default, the JVM will use 25% of the container memory limit as the heap limit; however, as an example the following would tell the JVM to use 75% of the container limit of 2GB of memory: + + -e MEMORY="" -e JVM_XX_OPTS="-XX:MaxRAMPercentage=75" -m 2000M + +> The settings above only set the Java **heap** limits. Memory resource requests and limits on the overall container should also account for non-heap memory usage. An extra 25% is [a general best practice](https://dzone.com/articles/best-practices-java-memory-arguments-for-container). + +### JVM Options + +General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS` +environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments. + +``` +docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ... +``` + +**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes: + +```yaml + environment: + - EULA=true + - JVM_OPTS=-someJVMOption someJVMOptionValue +``` + +Using object syntax is recommended and more intuitive: + +```yaml + environment: + EULA: "true" + JVM_OPTS: "-someJVMOption someJVMOptionValue" +# or +# JVM_OPTS: -someJVMOption someJVMOptionValue +``` + +As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.) + +For example, instead of passing + +```yaml + JVM_OPTS: -Dfml.queryResult=confirm -Dname=value +``` + +you can use + +```yaml + JVM_DD_OPTS: fml.queryResult=confirm,name=value +``` + +### Extra Arguments + +Arguments that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable. + +See [Custom worlds directory path](../misc/world-data.md#custom-worlds-directory-path) for an example. + +### Interactive and Color Console + +If you would like to `docker attach` to the Minecraft server console with color and interactive capabilities, then add + +``` + -e EXEC_DIRECTLY=true +``` + +> **NOTES** +> +> This feature doesn't work via rcon, so you will need to `docker attach` to the container. Use the sequence Ctrl-P, Ctrl-Q to detach. +> +> This will bypass graceful server shutdown handling when using `docker stop`, so be sure the server console's `stop` command. +> +> Make to enable stdin and tty with `-it` when using `docker run` or `stdin_open: true` and `tty: true` when using docker compose. +> +> This feature is incompatible with Autopause and cannot be set when `ENABLE_AUTOPAUSE=true`. + +### Server Shutdown Options + +To allow time for players to finish what they're doing during a graceful server shutdown, set `STOP_SERVER_ANNOUNCE_DELAY` to a number of seconds to delay after an announcement is posted by the server. + +> **NOTE** be sure to adjust Docker's shutdown timeout accordingly, such as using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/). + +### OpenJ9 Specific Options + +The openj9 image tags include specific variables to simplify configuration: + +- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to + [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/) +- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50% + of the `MAX_MEMORY` and the max size is 80%. + +### Enabling rolling logs + +By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by using: + +``` + -e ENABLE_ROLLING_LOGS=true +``` + +> **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console) + +### Timezone Configuration + +You can configure the timezone to match yours by setting the `TZ` environment variable: + + -e TZ=Europe/London + +such as: + + docker run -d -it -e TZ=Europe/London -p 25565:25565 --name mc itzg/minecraft-server + +Or mounting `/etc/timezone` as readonly (not supported on Windows): + + -v /etc/timezone:/etc/timezone:ro + +such as: + + docker run -d -it -v /etc/timezone:/etc/timezone:ro -p 25565:25565 --name mc itzg/minecraft-server + +### Enable Remote JMX for Profiling + +To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true`, set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as: + +``` +-e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091 +``` + +### Enable Aikar's Flags + +[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. The set of flags documented there can be added using + + -e USE_AIKAR_FLAGS=true + +When `MEMORY` is greater than or equal to 12G, then the Aikar flags will be adjusted according to the article. + +### HTTP Proxy + +You may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL via the `PROXY` +environment variable. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references +a companion squid proxy by setting the equivalent of + + -e PROXY=proxy:3128 + +### Using "noconsole" option + +Some older versions (pre-1.14) of Spigot required `--noconsole` to be passed when detaching stdin, which can be done by setting `-e CONSOLE=FALSE`. + +### Explicitly disable GUI + +Some older servers get confused and think that the GUI interface is enabled. You can explicitly +disable that by passing `-e GUI=FALSE`. + +### Stop Duration + +When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds. + +### Setup only + +If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. + +### Enable Flare Flags + +To enable the JVM flags required to fully support the [Flare profiling suite](https://blog.airplane.gg/flare), set the following variable: + + -e USE_FLARE_FLAGS=true + +Flare is built-in to Pufferfish/Purpur, and is available in [plugin form](https://github.com/TECHNOVE/FlarePlugin) for other server types. + +### Enable support for optimized SIMD operations + +To enable support for optimized SIMD operations, the JVM flag can be set with the following variable: + + -e USE_SIMD_FLAGS=true + +SIMD optimized operations are supported by Pufferfish and Purpur. + +### Enable timestamps in init logs + +Before the container starts the Minecraft Server its output is prefixed with `[init]`, such as + +``` +[init] Starting the Minecraft server... +``` + +To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The log output will then look like: + +``` +[init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server... +``` + +### Auto-execute RCON commands + +RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects. + +!!! note + + When declaring several commands within a compose file environment variable, it's easiest to use YAML's `|-` [block style indicator](https://yaml-multiline.info/). + +**On Server Start:** + +``` yaml + RCON_CMDS_STARTUP: |- + gamerule doFireTick false + pregen start 200 +``` + +**On Client Connection:** + +``` yaml + RCON_CMDS_ON_CONNECT: |- + team join New @a[team=] +``` + +**Note:** +* On client connect we only know there was a connection, and not who connected. RCON commands will need to be used for that. + +**On Client Disconnect:** + +``` yaml + RCON_CMDS_ON_DISCONNECT: |- + gamerule doFireTick true +``` + +**On First Client Connect** + +``` yaml + RCON_CMDS_FIRST_CONNECT: |- + pregen stop +``` + +**On Last Client Disconnect** + +``` yaml + RCON_CMDS_LAST_DISCONNECT: |- + kill @e[type=minecraft:boat] + pregen start 200 + +``` + +**Example of rules for new players** + +Uses team NEW and team OLD to track players on the server. So move player with no team to NEW, run a command, move them to team OLD. +[Reference Article](https://www.minecraftforum.net/forums/minecraft-java-edition/redstone-discussion-and/2213523-detect-players-first-join) + +``` yaml + RCON_CMDS_STARTUP: |- + /pregen start 200 + /gamerule doFireTick false + /team add New + /team add Old + RCON_CMDS_ON_CONNECT: |- + /team join New @a[team=] + /give @a[team=New] birch_boat + /team join Old @a[team=New] + RCON_CMDS_FIRST_CONNECT: |- + /pregen stop + RCON_CMDS_LAST_DISCONNECT: |- + /kill @e[type=minecraft:boat] + /pregen start 200 +``` diff --git a/docs/configuration/server-properties.md b/docs/configuration/server-properties.md new file mode 100644 index 00000000..33b114ae --- /dev/null +++ b/docs/configuration/server-properties.md @@ -0,0 +1,338 @@ +By default, the server configuration will be created and set based on the following environment variables, but only the first time the server is started. If the `server.properties` file already exists, the values in them will not be changed. + +If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SERVER_PROPERTIES` to "false". Similarly, you can entirely skip the startup script's creation of `server.properties` by setting `SKIP_SERVER_PROPERTIES` to "true". + +> NOTE: to clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. A variables that maps to a server property that is unset, is ignored and the existing `server.property` is left unchanged. + +### Message of the Day + +The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable, such as + + -e MOTD="My Server" + +If you leave it off, a default is computed from the server type and version, such as + + A Paper Minecraft Server powered by Docker + +That way you can easily differentiate between several servers you may have started. + +The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.fandom.com/wiki/Formatting_codes) to be used consistently with all server versions. For example, + + -e MOTD="A §l§cMinecraft§r §nserver" + +renders + +![](../img/motd-example.png) + +To produce a multi-line MOTD, you will need to double escape the newline such as + + -e MOTD="Line one\\nLine two" + +### Difficulty + +The difficulty level (default: `easy`) can be set like: + +``` +docker run -d -e DIFFICULTY=hard ... +``` + +Valid values are: `peaceful`, `easy`, `normal`, and `hard`, and an +error message will be output in the logs if it's not one of these +values. + +### Whitelist Players + +!!! note + + It is very important to set this with servers exposed to the internet where you want only limited players to join. + +To whitelist players for your Minecraft server, you can: + +- Provide a list of usernames and/or UUIDs separated by commas via the `WHITELIST` environment variable + `docker run -d -e WHITELIST=user1,uuid2 ...` +- Provide the url or path to a whitelist file via `WHITELIST_FILE` environment variable + `docker run -d -e WHITELIST_FILE=/extra/whitelist.json ...` + +When either is set, [whitelisting of connecting users](https://minecraft.fandom.com/wiki/Server.properties#white-list) is enabled . If managing the list manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property. + +If whitelist configuration already exists, `WHITELIST_FILE` will not be retrieved and any usernames in `WHITELIST` are **added** to the whitelist configuration. You can enforce regeneration of the whitelist on each server startup by setting `OVERRIDE_WHITELIST` to "true". This will delete the whitelist file before processing whitelist configuration. + +!!! note + + You can provide both `WHITELIST_FILE` and `WHITELIST`, which are processed in that order. + +!!! note + + UUIDs passed via `WHITELIST` need to be the dashed variant, otherwise it not be recognised and instead added as a username. + + If running Minecraft 1.7.5 or earlier, these variables will apply to `white-list.txt`, with 1.7.6 implementing support for `whitelist.json`. Make sure your `WHITELIST_FILE` is in the appropriate format. + +To [enforce the whitelist changes immediately](https://minecraft.fandom.com/wiki/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true". + +### Op/Administrator Players + +Similar to the whitelist, to add users as operators (aka adminstrators) to your Minecraft server, you can: + +- Provide te url or path to an ops file via `OPS_FILE` environment variable + `docker run -d -e OPS_FILE=https://config.example.com/extra/ops.json ...` +- Provide a list of usernames and/or UUIDs separated by commas via the `OPS` environment variable + `docker run -d -e OPS=user1,uuid2 ...` + +If ops configuration already exists, `OPS_FILE` will not be retrieved and any usernames in `OPS` are **added** to the ops configuration. You can enforce regeneration of the ops configuration on each server startup by setting `OVERRIDE_OPS` to "true". This will delete the ops file before processing ops configuration. + +!!! note + + Similar to whitelists, you can provide both `OPS_FILE` and `OPS`, and Minecraft 1.7.5 or earlier will use `ops.txt` rather than `ops.json`. + +### Enable/disable initial selection of datapacks + +New to [22W42A](https://www.minecraft.net/en-us/article/minecraft-snapshot-22w42a), datapacks with feature flags can be controlled before initial world creation by setting these to a comma separated list of packs: + +- `INITIAL_ENABLED_PACKS` + such as "update_1_20,bundle" +- `INITIAL_DISABLED_PACKS` + +### Server icon + +A server icon can be configured using the `ICON` variable. The image will be automatically +downloaded, scaled, and converted from any other image format: + + docker run -d -e ICON=http://..../some/image.png ... + +The server icon which has been set doesn't get overridden by default. It can be changed and overridden by setting `OVERRIDE_ICON` to `TRUE`. + + docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE... + +### RCON + +RCON is **enabled by default** to allow for graceful shut down the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false". + +The default password is "minecraft" but **change the password before deploying into production** by setting `RCON_PASSWORD`. + +**DO NOT MAP THE RCON PORT EXTERNALLY** unless you aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. + +!!! info + + Mapping ports (`-p` command line or `ports` in compose) outside the container and docker networking needs to be a purposeful choice. Most production Docker deployments do not need any of the Minecraft ports mapped externally from the server itself. + +By default, the server listens for RCON on port 25575 within the container. It can be changed with `RCON_PORT` but only do this if you have a very good reason. **DO NOT change `rcon.port` via `server.properties`** or integrations will break. + +### Query + +Enabling this will enable the gamespy query protocol. +By default the query port will be `25565` (UDP) but can easily be changed with the `QUERY_PORT` variable. + + docker run -d -e ENABLE_QUERY=true + +### Max players + +By default max players is 20, you can increase this with the `MAX_PLAYERS` variable. + + docker run -d -e MAX_PLAYERS=50 + +### Max world size + +This sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain. + + docker run -d -e MAX_WORLD_SIZE=10000 + +### Allow Nether + +Allows players to travel to the Nether. + + docker run -d -e ALLOW_NETHER=true + +### Announce Player Achievements + +Allows server to announce when a player gets an achievement. + + docker run -d -e ANNOUNCE_PLAYER_ACHIEVEMENTS=true + +### Enable Command Block + +Enables command blocks + + docker run -d -e ENABLE_COMMAND_BLOCK=true + +### Force Gamemode + +Force players to join in the default game mode. + +- false - Players will join in the gamemode they left in. +- true - Players will always join in the default gamemode. + + `docker run -d -e FORCE_GAMEMODE=false` + +### Generate Structures + +Defines whether structures (such as villages) will be generated. + +- false - Structures will not be generated in new chunks. +- true - Structures will be generated in new chunks. + + `docker run -d -e GENERATE_STRUCTURES=true` + +### Hardcore + +If set to true, players will be set to spectator mode if they die. + + docker run -d -e HARDCORE=false + +### Snooper + +If set to false, the server will not send data to snoop.minecraft.net server. + + docker run -d -e SNOOPER_ENABLED=false + +### Max Build Height + +The maximum height in which building is allowed. +Terrain may still naturally generate above a low height limit. + + docker run -d -e MAX_BUILD_HEIGHT=256 + +### Max Tick Time + +The maximum number of milliseconds a single tick may take before the server watchdog stops the server with the message, A single server tick took 60.00 seconds (should be max 0.05); Considering it to be crashed, server will forcibly shutdown. Once this criteria is met, it calls System.exit(1). +Setting this to -1 will disable watchdog entirely + + docker run -d -e MAX_TICK_TIME=60000 + +### Spawn Animals + +Determines if animals will be able to spawn. + + docker run -d -e SPAWN_ANIMALS=true + +### Spawn Monsters + +Determines if monsters will be spawned. + + docker run -d -e SPAWN_MONSTERS=true + +### Spawn NPCs + +Determines if villagers will be spawned. + + docker run -d -e SPAWN_NPCS=true + +### Set spawn protection + +Sets the area that non-ops can not edit (0 to disable) + + docker run -d -e SPAWN_PROTECTION=0 + +### View Distance + +Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). +It determines the server-side viewing distance. + + docker run -d -e VIEW_DISTANCE=10 + +### Level Seed + +If you want to create the Minecraft level with a specific seed, use `SEED`, such as + + -e SEED=1785852800490497919 + +If using a negative value for the seed, make sure to quote the value such as: + + -e SEED="-1785852800490497919" + +### Game Mode + +By default, Minecraft servers are configured to run in Survival mode. You can +change the mode using `MODE` where you can either provide the [standard +numerical values](http://minecraft.gamepedia.com/Game_mode#Game_modes) or the +shortcut values: + +- creative +- survival +- adventure +- spectator (only for Minecraft 1.8 or later) + +For example: + + docker run -d -e MODE=creative ... + +### PVP Mode + +By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP` +environment variable set to `false`, such as + + docker run -d -e PVP=false ... + +### Level Type and Generator Settings + +By default, a standard world is generated with hills, valleys, water, etc. A different level type can +be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.fandom.com/wiki/Server.properties#level-type). + +For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation [as described here](https://minecraft.fandom.com/wiki/Server.properties#generator-settings). + +### Custom Server Resource Pack + +You can set a link to a custom resource pack and set it's checksum using the `RESOURCE_PACK` and `RESOURCE_PACK_SHA1` options respectively, the default is blank: + + docker run -d -e 'RESOURCE_PACK=http://link.com/to/pack.zip?=1' -e 'RESOURCE_PACK_SHA1=d5db29cd03a2ed055086cef9c31c252b4587d6d0' + +You can enforce the resource pack on clients by setting `RESOURCE_PACK_ENFORCE` to `TRUE` (default: `FALSE`). + +### Level / World Save Name + +You can either switch between world saves or run multiple containers with different saves by using the `LEVEL` option, +where the default is "world": + + docker run -d -e LEVEL=bonus ... + +> **NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each +`LEVEL` in use or don't use `-v` and the container's filesystem will keep things encapsulated. + +> **INFO** Refer to the [data directory](../data-directory.md) section for a visual description of where the `$LEVEL` directory is situated. + +### Online mode + +By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players with environment variable `ONLINE_MODE`, like this + + docker run -d -e ONLINE_MODE=FALSE ... + +### Allow flight + +Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed. + + -e ALLOW_FLIGHT=TRUE|FALSE + +### Server name + +The server name (e.g. for bungeecord) can be set like: + + docker run -d -e SERVER_NAME=MyServer ... + +### Server port + +> **WARNING:** only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used. Use `-p` port mappings instead. + +If you must, the server port can be set like: + + docker run -d -e SERVER_PORT=25566 ... + +**however**, be sure to change your port mapping accordingly and be prepared for some features to break. + +### Other server property mappings + +| Environment Variable | Server Property | +| --------------------------------- | --------------------------------- | +| PLAYER_IDLE_TIMEOUT | player-idle-timeout | +| BROADCAST_CONSOLE_TO_OPS | broadcast-console-to-ops | +| BROADCAST_RCON_TO_OPS | broadcast-rcon-to-ops | +| ENABLE_JMX | enable-jmx-monitoring | +| SYNC_CHUNK_WRITES | sync-chunk-writes | +| ENABLE_STATUS | enable-status | +| ENTITY_BROADCAST_RANGE_PERCENTAGE | entity-broadcast-range-percentage | +| FUNCTION_PERMISSION_LEVEL | function-permission-level | +| NETWORK_COMPRESSION_THRESHOLD | network-compression-threshold | +| OP_PERMISSION_LEVEL | op-permission-level | +| PREVENT_PROXY_CONNECTIONS | prevent-proxy-connections | +| USE_NATIVE_TRANSPORT | use-native-transport | +| ENFORCE_WHITELIST | enforce-whitelist | +| ENABLE_WHITELIST | white-list and whitelist | +| SIMULATION_DISTANCE | simulation-distance | diff --git a/docs/.gitkeep b/docs/css/extra.css similarity index 100% rename from docs/.gitkeep rename to docs/css/extra.css diff --git a/docs/data-directory.md b/docs/data-directory.md new file mode 100644 index 00000000..36737420 --- /dev/null +++ b/docs/data-directory.md @@ -0,0 +1,84 @@ +Everything the container manages is located under the **container's** `/data` path, as shown here: + +![](img/level-vs-world.drawio.png) + +!!! note + + The container path `/data` is pre-declared as a volume, so if you do nothing then it will be allocated as an anonymous volume. As such, it is subject to removal when the container is removed. + +### Attaching data directory to host filesystem + +In most cases the easiest way to persist and work with the minecraft data files is to use the [volume mounting](https://docs.docker.com/storage/volumes/) `-v` argument to map a directory on your host machine to the container's `/data` directory. In the following example, the path `/home/user/minecraft-data` **must be** a directory on your host machine: + + -v /home/user/minecraft-data:/data + ------------------------- ----- + | | + | +-- must always be /data + | + +-- replace with a directory on your host machine + +When attached in this way you can stop the server, edit the configuration under your attached directory and start the server again to pick up the new configuration. + +With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `docker-compose.yml` Docker will automatically create/attach the relative directory `minecraft-data` to the container. + +``` yaml title="docker-compose.yml" +version: "3" + +services: + mc: + image: itzg/minecraft-server + ports: + - 25565:25565 + environment: + EULA: "TRUE" + tty: true + stdin_open: true + restart: unless-stopped + volumes: + # attach a directory relative to the directory containing this compose file + - ./minecraft-data:/data +``` + +!!! note + + if you have SELinux enabled, then you might need to add `:Z` to the end of volume mount specifications, [as described here](https://prefetch.net/blog/2017/09/30/using-docker-volumes-on-selinux-enabled-servers/). + +### Converting anonymous `/data` volume to named volume + +If you had used the commands in the first section, without the `-v` volume attachment, then an anonymous data volume was created by Docker. You can later bring over that content to a named or host attached volume using the following procedure. + +!!! note + + In this example, it is assumed the original container was given a `--name` of "mc", so change the container identifier accordingly. + + You can also locate the Docker-managed directory from the `Source` field obtained from `docker inspect -f "{{json .Mounts}}"` + +First, stop the existing container: + +``` shell +docker stop mc +``` + +Use a temporary container to copy over the anonymous volume's content into a named volume, "mc" in this case: + +``` shell +docker run --rm --volumes-from mc -v mc:/new alpine cp -avT /data /new +``` + +Now you can recreate the container with any environment variable changes, etc by attaching the named volume created from the previous step: + +``` shell +docker run -d -it --name mc-new -v mc:/data -p 25565:25565 -e EULA=TRUE -e MEMORY=2G itzg/minecraft-server +``` + +### Locating filesystem path of anonymous volume + +The `Source` field from the output of this command will show where the anonymous volume is mounted from: + +``` shell +docker inspect -f "{{json .Mounts}}" CONTAINER_NAME_OR_ID +``` + +!!! note + + On Windows with WSL the volumes path is `\\wsl$\docker-desktop-data\data\docker\volumes` diff --git a/docs/deployment/aws.md b/docs/deployment/aws.md new file mode 100644 index 00000000..78e89bc8 --- /dev/null +++ b/docs/deployment/aws.md @@ -0,0 +1 @@ +If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use. diff --git a/docs/deployment/docker-compose.md b/docs/deployment/docker-compose.md new file mode 100644 index 00000000..d9aec163 --- /dev/null +++ b/docs/deployment/docker-compose.md @@ -0,0 +1,26 @@ +Rather than type the server options below, the port mappings above, etc +every time you want to create new Minecraft server, you can now use +[Docker Compose](https://docs.docker.com/compose/). Start with a +`docker-compose.yml` file like the following: + +``` yaml +version: "3" + +services: + mc: + image: itzg/minecraft-server + ports: + - 25565:25565 + environment: + EULA: "TRUE" + tty: true + stdin_open: true + restart: unless-stopped +``` + +and in the same directory as that file run + + docker-compose up -d + +Now, go play...or adjust the `environment` section to configure +this server instance. diff --git a/docs/deployment/helmcharts.md b/docs/deployment/helmcharts.md new file mode 100644 index 00000000..5b4ba9bc --- /dev/null +++ b/docs/deployment/helmcharts.md @@ -0,0 +1,8 @@ +- itzg Helm Chart: + - [GitHub repo](https://github.com/itzg/minecraft-server-charts) + - [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/) +- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts) + +### Examples + +The [examples directory](https://github.com/itzg/docker-minecraft-server/tree/master/examples) also provides examples of deploying the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server/) Docker image. diff --git a/docs/example-autocf-downloads.drawio.png b/docs/example-autocf-downloads.drawio.png deleted file mode 100644 index f2a9dc46..00000000 Binary files a/docs/example-autocf-downloads.drawio.png and /dev/null differ diff --git a/docs/ftba-version-id-popup.png b/docs/ftba-version-id-popup.png deleted file mode 100644 index 3d460140..00000000 Binary files a/docs/ftba-version-id-popup.png and /dev/null differ diff --git a/docs/.gitignore b/docs/img/.gitignore similarity index 100% rename from docs/.gitignore rename to docs/img/.gitignore diff --git a/docs/cf-file-id.png b/docs/img/cf-file-id.png similarity index 100% rename from docs/cf-file-id.png rename to docs/img/cf-file-id.png diff --git a/docs/img/cf-project-id.png b/docs/img/cf-project-id.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/cf-slug.png b/docs/img/cf-slug.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/example-autocf-downloads.drawio.png b/docs/img/example-autocf-downloads.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/ftba-version-id-popup.png b/docs/img/ftba-version-id-popup.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/level-vs-world.drawio.png b/docs/img/level-vs-world.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/modrinth-project-id.drawio.png b/docs/img/modrinth-project-id.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/modrinth-project-slug.drawio.png b/docs/img/modrinth-project-slug.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/modrinth-version-id.drawio.png b/docs/img/modrinth-version-id.drawio.png similarity index 100% rename from docs/modrinth-version-id.drawio.png rename to docs/img/modrinth-version-id.drawio.png diff --git a/docs/img/motd-example.png b/docs/img/motd-example.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/img/world-copy-compose-project.drawio.png b/docs/img/world-copy-compose-project.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..8a46e842 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,30 @@ +[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-server.svg)](https://hub.docker.com/r/itzg/minecraft-server/) +[![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?maxAge=2592000)](https://hub.docker.com/r/itzg/minecraft-server/) +[![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-server.svg)](https://github.com/itzg/docker-minecraft-server/issues) +[![Discord](https://img.shields.io/discord/660567679458869252?label=Discord&logo=discord)](https://discord.gg/DXfKpjB) +[![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions) +[![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg) + +This docker image provides a Minecraft Server that will automatically download the latest stable +version at startup. You can also run/upgrade to any specific version or the +latest snapshot. See the _Versions_ section below for more information. + +To simply use the latest stable version, run + + docker run -d -it -p 25565:25565 -e EULA=TRUE itzg/minecraft-server + +where, in this case, the standard server port 25565, will be exposed on your host machine. + +!!! note + + If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](#deployment-templates-and-examples) to allow for incremental reconfiguration and image upgrades. + +!!! info + + Be sure to always include `-e EULA=TRUE` in your commands and container definitions, as Mojang/Microsoft requires EULA acceptance. + +!!! warning + + **DO NOT** port forward RCON on 25575 without first setting `RCON_PASSWORD` to a secure value. It is highly recommended to only use RCON within the container, such as with `rcon-cli`. + +By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/java.md) and the [`TYPE`](server-types) can be configured to create many variations of desired Minecraft server. diff --git a/docs/level-vs-world.drawio.png b/docs/level-vs-world.drawio.png deleted file mode 100644 index 2a600cfe..00000000 Binary files a/docs/level-vs-world.drawio.png and /dev/null differ diff --git a/docs/misc/autopause/autostop.md b/docs/misc/autopause/autostop.md new file mode 100644 index 00000000..8424422b --- /dev/null +++ b/docs/misc/autopause/autostop.md @@ -0,0 +1,25 @@ +# AutoStop + +An option to stop the server after a specified time has been added for niche applications (e.g. billing saving on AWS Fargate). The function is incompatible with the Autopause functionality, as they basically cancel out each other. + +!!! note + + the docker container variables have to be set accordingly (restart policy set to "no") and that the container has to be manually restarted. + +A starting, example compose file has been provided in [examples/docker-compose-autostop.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autostop.yml). + +Enable the Autostop functionality by setting: + +``` +-e ENABLE_AUTOSTOP=TRUE +``` + +The following environment variables define the behavior of auto-stopping: +* `AUTOSTOP_TIMEOUT_EST`, default `3600` (seconds) + describes the time between the last client disconnect and the stopping of the server (read as timeout established) +* `AUTOSTOP_TIMEOUT_INIT`, default `1800` (seconds) + describes the time between server start and the stopping of the server, when no client connects in-between (read as timeout initialized) +* `AUTOSTOP_PERIOD`, default `10` (seconds) + describes period of the daemonized state machine, that handles the stopping of the server + +> To troubleshoot, add `DEBUG_AUTOSTOP=true` to see additional output diff --git a/docs/misc/autopause/index.md b/docs/misc/autopause/index.md new file mode 100644 index 00000000..97d74b88 --- /dev/null +++ b/docs/misc/autopause/index.md @@ -0,0 +1,71 @@ +# AutoPause + +### Description + +There are various bug reports on [Mojang](https://bugs.mojang.com) about high CPU usage of servers with newer versions, even with few or no clients connected (e.g. [this one](https://bugs.mojang.com/browse/MC-149018), in fact the functionality is based on [this comment in the thread](https://bugs.mojang.com/browse/MC-149018?focusedCommentId=593606&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-593606)). + +An autopause functionality has been added to this image to monitor whether clients are connected to the server. If for a specified time no client is connected, the Java process is stopped. When knocking on the server port (e.g. by the ingame Multiplayer server overview), the process is resumed. The experience for the client does not change. + +Of course, even loaded chunks are not ticked when the process is stopped. + +**You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [the section below](../../configuration/server-properties.md#max-tick-time). + +!!! note + + Non-vanilla versions might have their own configuration file, you might have to disable their watchdogs separately. For PaperMC servers, you need to send the JVM flag `-Ddisable.watchdog=true`, this can be done with the docker env variable `-e JVM_DD_OPTS=disable.watchdog:true` + +On startup the `server.properties` file is checked and, if applicable, a warning is printed to the terminal. When the server is created (no data available in the persistent directory), the properties file is created with the Watchdog disabled. + +The utility used to wake the server (`knock(d)`) works at network interface level. So the correct interface has to be set using the `AUTOPAUSE_KNOCK_INTERFACE` variable when using non-default networking environments (e.g. host-networking, Portainer oder NAS solutions). See the description of the variable below. + +A file called `.paused` is created in `/data` directory when the server is paused and removed when the server is resumed. Other services may check for this file's existence before waking the server. + +A starting, example compose file has been provided in [examples/docker-compose-autopause.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autopause.yml). + +### Enabling Autopause + +Enable the Autopause functionality by setting: + +``` +-e ENABLE_AUTOPAUSE=TRUE +``` + +Autopause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together. + +!!! note + + When configuring kubernetes readiness/liveness health checks with auto-pause enabled, be sure to reference the `mc-health` wrapper script rather than `mc-status` directly. + +The following environment variables define the behaviour of auto-pausing: + +- `AUTOPAUSE_TIMEOUT_EST`, default `3600` (seconds) + describes the time between the last client disconnect and the pausing of the process (read as timeout established) +- `AUTOPAUSE_TIMEOUT_INIT`, default `600` (seconds) + describes the time between server start and the pausing of the process, when no client connects inbetween (read as timeout initialized) +- `AUTOPAUSE_TIMEOUT_KN`, default `120` (seconds) + describes the time between knocking of the port (e.g. by the main menu ping) and the pausing of the process, when no client connects inbetween (read as timeout knocked) +- `AUTOPAUSE_PERIOD`, default `10` (seconds) + describes period of the daemonized state machine, that handles the pausing of the process (resuming is done independently) +- `AUTOPAUSE_KNOCK_INTERFACE`, default `eth0` +
Describes the interface passed to the `knockd` daemon. If the default interface does not work, run the `ifconfig` command inside the container and derive the interface receiving the incoming connection from its output. The passed interface must exist inside the container. Using the loopback interface (`lo`) does likely not yield the desired results. + +!!! tip + + To troubleshoot, add `DEBUG_AUTOPAUSE=true` to see additional output + +### Rootless Autopause + +If you're running the container as rootless, you might need to set change the default port forwarder from RootlessKit to slirp4netns. + +For Docker, see the following for setup: + +- https://docs.docker.com/engine/security/rootless/#networking-errors +- https://rootlesscontaine.rs/getting-started/docker/#changing-the-port-forwarder + +For Podman, see the following for setup: +- https://rootlesscontaine.rs/getting-started/podman/#changing-the-port-forwarder +- Run with + + ``` + -e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns + ``` diff --git a/docs/misc/healthcheck.md b/docs/misc/healthcheck.md new file mode 100644 index 00000000..008104ab --- /dev/null +++ b/docs/misc/healthcheck.md @@ -0,0 +1,27 @@ +## Healthcheck + +This image contains [mc-monitor](https://github.com/itzg/mc-monitor) and uses its `status` command to continually check on the container's. That can be observed from the `STATUS` column of `docker ps` + +``` +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +b418af073764 mc "/start" 43 seconds ago Up 41 seconds (healthy) 0.0.0.0:25565->25565/tcp, 25575/tcp mc +``` + +You can also query the container's health in a script friendly way: + +``` shell +> docker container inspect -f "{{.State.Health.Status}}" mc +healthy +``` + +There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a compose file, then use something like the following in the service declaration: + +``` yaml +healthcheck: + test: mc-health + start_period: 1m + interval: 5s + retries: 20 +``` + +Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of healthchecks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`. diff --git a/docs/misc/log4j.md b/docs/misc/log4j.md new file mode 100644 index 00000000..b30ba4a6 --- /dev/null +++ b/docs/misc/log4j.md @@ -0,0 +1 @@ +**Please ensure you have pulled the latest image** since [all official mitigations](https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition) are automatically applied by the container startup process. diff --git a/docs/misc/raspberrypi.md b/docs/misc/raspberrypi.md new file mode 100644 index 00000000..dd68be7a --- /dev/null +++ b/docs/misc/raspberrypi.md @@ -0,0 +1,9 @@ +To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags [list in the Java version section](../versions/java.md) that specify `armv7` for the architecture, which includes `itzg/minecraft-server:latest`. + +!!! note + + You may need to lower the memory allocation, such as `-e MEMORY=750m` + +!!! note + + If experiencing issues such as "sleep: cannot read realtime clock: Operation not permitted", ensure `libseccomp` is up to date on your host. In some cases adding `:Z` flag to the `/data` mount may be needed, [but use cautiously](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label). diff --git a/docs/misc/rcon.md b/docs/misc/rcon.md new file mode 100644 index 00000000..fb51ba08 --- /dev/null +++ b/docs/misc/rcon.md @@ -0,0 +1,41 @@ +[RCON](http://wiki.vg/RCON) is enabled by default, so you can `exec` into the container to +access the Minecraft server console: + +``` +docker exec -i mc rcon-cli +``` + +Note: The `-i` is required for interactive use of rcon-cli. + +To run a simple, one-shot command, such as stopping a Minecraft server, pass the command as arguments to `rcon-cli`, such as: + +``` +docker exec mc rcon-cli stop +``` + +_The `-i` is not needed in this case._ + +If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script. For example, a player can be op'ed in the container `mc` with: + +```shell +docker exec mc mc-send-to-console op player + | | + +- container name +- Minecraft commands start here +``` + +In order to attach and interact with the Minecraft server, add `-it` when starting the container, such as + + docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server + +With that you can attach and interact at any time using + + docker attach mc + +and then Control-p Control-q to **detach**. + +For remote access, configure your Docker daemon to use a `tcp` socket (such as `-H tcp://0.0.0.0:2375`) +and attach from another machine: + + docker -H $HOST:2375 attach mc + +Unless you're on a home/private LAN, you should [enable TLS access](https://docs.docker.com/articles/https/). diff --git a/docs/misc/troubleshooting.md b/docs/misc/troubleshooting.md new file mode 100644 index 00000000..22d90795 --- /dev/null +++ b/docs/misc/troubleshooting.md @@ -0,0 +1,5 @@ +To troubleshoot the container initialization, such as when server files are pre-downloaded, set the environment variable `DEBUG` to `true`. The container logs will include **much more** output, and it is highly recommended including that output when reporting any [issues](https://github.com/itzg/docker-minecraft-server/issues). + +To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`. + +To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`. diff --git a/docs/misc/world-data.md b/docs/misc/world-data.md new file mode 100644 index 00000000..c6a12d6b --- /dev/null +++ b/docs/misc/world-data.md @@ -0,0 +1,126 @@ + +## Downloadable world + +Instead of mounting the `/data` volume, you can instead specify the URL of a ZIP or compressed TAR file containing an archived world. It will be searched for a file `level.dat` and the containing subdirectory moved to the directory named by `$LEVEL`. This means that most of the archived Minecraft worlds downloadable from the Internet will already be in the correct format. + + docker run -d -e WORLD=http://www.example.com/worlds/MySave.zip ... + +!!! note + + This URL must be accessible from inside the container. Therefore, you should use an IP address or a globally resolvable FQDN, or else the name of a linked container. + +!!! note + + If the archive contains more than one `level.dat`, then the one to select can be picked with `WORLD_INDEX`, which defaults to 1. + +## Cloning world from a container path + +The `WORLD` option can also be used to reference a directory, zip file, or compressed tar file that will be used as a source to clone or extract the world directory. + +For example, the following would initially clone the world's content from `/worlds/basic`. Also notice in the example that you should use a read-only volume attachment to ensure the clone source remains pristine. + +``` +docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic +``` + +The following diagram shows how this option can be used in a compose deployment with a relative directory: + +![](../img/world-copy-compose-project.drawio.png) + +## Overwrite world on start +The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start. + +## Custom worlds directory path +To set a custom worlds directory for the Multiverse plugin on a baremetal server, you'd pass the `--world-dir` argument after the jar file. +In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` environment variable in your command line or docker compose yaml to the same argument string. For example: + +``` +docker run -d -e EXTRA_ARGS='--world-dir ./worlds/' +``` +`--world-container`, `-W`, and `--universe` are aliases to `--world-dir` and can also be used. + +## Datapacks + +Datapacks can be installed in a similar manner to mods/plugins. There are many environment variables which function in the same way they do for [mods](../mods-and-plugins/index.md): + +* `DATAPACKS`: comma-separated list of zip file URL, zip file in container, or directory in container +* `DATAPACKS_FILE`: a text file within the container where each line is a zip file URL, zip file in container, or directory in container +* `REMOVE_OLD_DATAPACKS`: if "true" the datapacks directory is removed of everything matching `REMOVE_OLD_DATAPACKS_INCLUDE`, but excluding `REMOVE_OLD_DATAPACKS_EXCLUDE` no deeper than `REMOVE_OLD_DATAPACKS_DEPTH` +* `REMOVE_OLD_DATAPACKS_DEPTH`: default is 16 +* `REMOVE_OLD_DATAPACKS_INCLUDE`: default is `*.zip` +* `REMOVE_OLD_DATAPACKS_EXCLUDE`: default is empty + +Datapacks will be placed in `/data/$LEVEL/datapacks` + +## VanillaTweaks + +[VanillaTweaks](https://vanillatweaks.net/) datapacks, crafting tweaks, and resource packs can be installed with a share code from the website **OR** a json file to specify packs to download and install. Datapacks and crafting tweaks will be installed into the current world directory specified by `$LEVEL`. As new versions of the packs are retrieved the previous versions will automatically be cleaned up. + +The share code is the part following the hash sign, as shown here: + +``` +https://vanillatweaks.net/share/#MGr52E + ------ + | + +- share code MGr52E +``` + +Accepted Parameters: + +- `VANILLATWEAKS_FILE`: comma separated list of JSON VanillaTweak pack files accessible within the container +- `VANILLATWEAKS_SHARECODE`: comma separated list of share codes + +Example of expected VanillaTweaks share codes: + +!!! note + + ResourcePacks, DataPacks, and CraftingTweaks all have separate sharecodes + +``` yaml +VANILLATWEAKS_SHARECODE: MGr52E,tF1zL2,LnEDwT +``` + +Example of expected VanillaTweaks files: + +``` yaml +VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/config/vt-resourcepacks.json +``` + +``` json title="DataPacks json" +{ + "type": "datapacks", + "version": "1.18", + "packs": { + "survival": [ + "graves", + "multiplayer sleep" + ], + "items": ["armored elytra"] + } +} +``` + +``` json title="ResourcePacks json" +{ + "type": "resourcepacks", + "version": "1.18", + "packs": { + "aesthetic": ["CherryPicking", "BlackNetherBricks", "AlternateBlockDestruction"] + } +} +``` + + +``` json title="CraftingTweaks Json" +{ + "type": "craftingtweaks", + "version": "1.18", + "packs": { + "quality of life": [ + "dropper to dispenser", + "double slabs", + "back to blocks" + ] + } +} +``` diff --git a/docs/modrinth-project-id.drawio.png b/docs/modrinth-project-id.drawio.png deleted file mode 100644 index d299f0c0..00000000 Binary files a/docs/modrinth-project-id.drawio.png and /dev/null differ diff --git a/docs/modrinth-project-slug.drawio.png b/docs/modrinth-project-slug.drawio.png deleted file mode 100644 index f8dd5154..00000000 Binary files a/docs/modrinth-project-slug.drawio.png and /dev/null differ diff --git a/docs/mods-and-plugins/curseforge.md b/docs/mods-and-plugins/curseforge.md new file mode 100644 index 00000000..077ca5a4 --- /dev/null +++ b/docs/mods-and-plugins/curseforge.md @@ -0,0 +1,145 @@ +## Auto CurseForge Management + +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`. +> +> When entering your API Key in a docker compose file you will need to escape any `$` character with a second `$`. +> +> Example if your key is `$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa`: +> ```yaml +> environment: +> CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa' +> ``` +> If you use `docker run` you will need to make sure to use single quotes: +> +> ```shell +> docker run ... -e CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa' +> ``` +> +> To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). `$`'s in the value still need to escaped with a second `$` and the variable needs to be referenced from the compose file, such as: +> ```yaml +> environment: +> CF_API_KEY: ${CF_API_KEY} +> ``` +> +> To use the equivalent with `docker run` you need to specify the `.env` file explicitly: +> ``` +> docker run --env-file=.env itzg/minecraft-server +> ``` +> +> Be sure to use the appropriate [image tag for the Java version compatible with the modpack](../versions/java.md). +> +> 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. + +Use one of the following to specify the modpack to install: + +Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the modpack page "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8" or a specific file "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390". For example: + +``` +-e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 +``` + +Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as + +![cf-slug](../img/cf-slug.png) + +For example: +``` +-e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8 +``` + +For mod, modpacks, and world files that are not allowed for automated download, the container path `/downloads` can be attached and matching files will be retrieved from there. The subdirectories `mods`, `modpacks`, and `worlds` will also be checked accordingly. To change the source location of downloaded files, set `CF_DOWNLOADS_REPO` to an existing container path. To disable this feature, set `CF_DOWNLOADS_REPO` to an empty string. + +If the authors of the modpack have disallowed project distribution, then the desired **client** modpack zip will need to be manually downloaded and made available to the container. The path to that file must be passed to `CF_MODPACK_ZIP`. Similarly, the container path to a modpack manifest JSON can be passed to `CF_MODPACK_MANIFEST`. In either case, the modpack slug or page URL must still be provided. + +The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup. + +- Use `CF_PAGE_URL`, but include the full URL to a specific file +- Set `CF_FILE_ID` to the numerical file ID +- Specify a substring to match the desired filename with `CF_FILENAME_MATCHER` + +The following shows where to get the URL to the specific file and also shows where the file ID is located: + +![cf-file-id](../img/cf-file-id.png) + +The following examples all refer to version 1.0.7 of ATM8: + +``` +-e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390 +``` + +``` +-e CF_SLUG=all-the-mods-8 -e CF_FILE_ID=4248390 +``` + +``` +-e CF_SLUG=all-the-mods-8 -e CF_FILENAME_MATCHER=1.0.7 +``` + +Quite often there are mods that need to be excluded, such as ones that did not properly declare as a client mod via the file's game versions. Similarly, there are some mods that are incorrectly tagged as client only. The following describes two options to exclude/include mods: + +Global and per modpack exclusions can be declared in a JSON file and referenced with `CF_EXCLUDE_INCLUDE_FILE`. By default, [the file bundled with the image](https://raw.githubusercontent.com/itzg/docker-minecraft-server/master/files/cf-exclude-include.json) will be used, but can be disabled by setting this to an empty string. The schema of this file [is documented here](https://github.com/itzg/mc-image-helper#excludeinclude-file-schema). + +Alternatively, they can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. These lists will be combined with the content of the exclude/include file, if given. + +A mod's project ID can be obtained from the right hand side of the project page: +![cf-project-id](../img/cf-project-id.png) + +If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true" to ensure the exclude/includes are re-evaluated. + +> **NOTE:** these options are provided to empower you to get your server up and running quickly. Please help out by reporting an issue with the respective mod project. Ideally mod developers should [use correct registrations for one-sided client mods](https://docs.minecraftforge.net/en/latest/concepts/sides/#writing-one-sided-mods). Understandably, those code changes may be non-trivial, so mod authors can also add "Client" to the game versions when publishing. + +Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the `LEVEL` to the resulting saves directory by setting `CF_SET_LEVEL_FROM` to either: +- `WORLD_FILE` +- `OVERRIDES` + +Other configuration available: +- `CF_PARALLEL_DOWNLOADS` (default is 4): specify how many parallel mod downloads to perform +- `CF_OVERRIDES_SKIP_EXISTING` (default is false): if set, files in the overrides that already exist in the data directory are skipped. **NOTE** world data is always skipped, if present. + +## Old approach + +Enable this server mode by adding `-e TYPE=CURSEFORGE` to your command-line, +but note the following additional steps needed... + +You need to specify a modpack to run, using the `CF_SERVER_MOD` environment +variable. A CurseForge server modpack is available together with its respective +client modpack at . + +Now you can add a `-e CF_SERVER_MOD=name_of_modpack.zip` to your command-line. + + docker run -d -v /path/on/host:/data -e TYPE=CURSEFORGE \ + -e CF_SERVER_MOD=SkyFactory_4_Server_4.1.0.zip \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server + +If you want to keep the pre-download modpacks separate from your data directory, +then you can attach another volume at a path of your choosing and reference that. +The following example uses `/modpacks` as the container path as the pre-download area: + + docker run -d -v /path/on/host:/data -v /path/to/modpacks:/modpacks \ + -e TYPE=CURSEFORGE \ + -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server + +### Modpack data directory + +By default, CurseForge modpacks are expanded into the sub-directory `/data/FeedTheBeast` and executed from there. (The default location was chosen for legacy reasons, when Curse and FTB were maintained together.) + +The directory can be changed by setting `CF_BASE_DIR`, such as `-e CF_BASE_DIR=/data`. + +### Buggy start scripts + +Some modpacks have buggy or overly complex start scripts. You can avoid using the bundled start script and use this image's standard server-starting logic by adding `-e USE_MODPACK_START_SCRIPT=false`. + +### Fixing "unable to launch forgemodloader" + +If your server's modpack fails to load with an error [like this](https://support.feed-the-beast.com/t/cant-start-crashlanding-server-unable-to-launch-forgemodloader/6028/2): + + unable to launch forgemodloader + +then you apply a workaround by adding this to the run invocation: + + -e FTB_LEGACYJAVAFIXER=true diff --git a/docs/mods-and-plugins/feed-the-beast.md b/docs/mods-and-plugins/feed-the-beast.md new file mode 100644 index 00000000..badfcc87 --- /dev/null +++ b/docs/mods-and-plugins/feed-the-beast.md @@ -0,0 +1,33 @@ +!!! note + + Requires one of the Ubuntu with Hotspot images listed in [the Java versions section](../versions/java.md). + +[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 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](../img/ftba-version-id-popup.png). + +### Upgrading + +If a specific `FTB_MODPACK_VERSION_ID` was not specified, simply restart the container to pick up the newest modpack version. If using a specific version ID, recreate the container with the new version ID. + +### Example + +The following example runs the latest version of [FTB Presents Direwolf20 1.12](https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/): + +``` shell +docker run -d --name mc-ftb -e EULA=TRUE \ + -e TYPE=FTBA -e FTB_MODPACK_ID=31 \ + -p 25565:25565 \ + itzg/minecraft-server:java8-multiarch +``` + +!!! note + + Normally you will also add `-v` volume for `/data` since the mods and config are installed there along with world data. diff --git a/docs/mods-and-plugins/index.md b/docs/mods-and-plugins/index.md new file mode 100644 index 00000000..7dad1fc6 --- /dev/null +++ b/docs/mods-and-plugins/index.md @@ -0,0 +1,195 @@ +### Optional plugins, mods, and config attach points + +There are optional volume paths that can be attached to supply content to be copied into the data area: + +`/plugins` +: contents are synchronized into `/data/plugins` for Bukkit related server types. The source can be changed by setting `COPY_PLUGINS_SRC`. The destination can be changed by setting `COPY_PLUGINS_DEST`. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`. + +`/mods` +: contents are synchronized into `/data/mods` for Fabric and Forge related server types. The source can be changed by setting `COPY_MODS_SRC`. The destination can be changed by setting `COPY_MODS_DEST`. + +`/config` +: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. The source can be changed by setting `COPY_CONFIG_SRC`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`. + +By default, the [environment variable processing](../configuration/misc-options.md#replacing-variables-inside-configs) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`. + +If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, only jars are removed. + +You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level. + +For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory. + +These paths work well if you want to have a common set of modules in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive. + +> For more flexibility with mods/plugins preparation, you can declare directories to use in [the `MODS` variable](#downloadable-modplugin-pack-for-forge-fabric-and-bukkit-like-servers) + +### Auto-downloading SpigotMC/Bukkit/PaperMC plugins with Spiget + +The `SPIGET_RESOURCES` variable can be set with a comma-separated list of SpigotMC resource IDs to automatically download [SpigotMC resources/plugins](https://www.spigotmc.org/resources/) using [the spiget API](https://spiget.org/). Resources that are zip files will be expanded into the plugins directory and resources that are simply jar files will be moved there. + +> NOTE: the variable is purposely spelled SPIG**E**T with an "E" + +The **resource ID** can be located from the numerical part of the URL after the shortname and a dot. For example, the ID is **9089** from + + https://www.spigotmc.org/resources/essentialsx.9089/ + ==== + +For example, the following will auto-download the [EssentialsX](https://www.spigotmc.org/resources/essentialsx.9089/) and [Vault](https://www.spigotmc.org/resources/vault.34315/) plugins: + + -e SPIGET_RESOURCES=9089,34315 + +### Auto-download mods from Modrinth + +[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric and Forge mods](https://modrinth.com/mods). At startup, the container will automatically locate and download the newest versions of mod files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up. + +- **MODRINTH_PROJECTS** : comma separated list of project slugs (short name) or IDs. The project ID can be located in the "Technical information" section. The slug is the part of the page URL that follows `/mod/`: + ``` + https://modrinth.com/mod/fabric-api + ---------- + | + +-- project slug + ``` + Also, specific version/type can be declared using colon symbol and version id/type after the project slug. The version id can be found at 'Metadata' section. Valid version types are `release`, `beta`, `alpha`. For instance: + ``` + -e MODRINTH_PROJECTS=fabric-api,fabric-api:PbVeub96,fabric-api:beta + ``` +- **MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES**=true : required dependencies of the project will _always_ be downloaded and optional dependencies can also be downloaded by setting this to `true` +- **MODRINTH_ALLOWED_VERSION_TYPE**=release : the version type is used to determine the newest version to use from each project. The allowed values are `release`, `beta`, `alpha`. + +### Downloadable mod/plugin pack for Forge, Fabric, and Bukkit-like Servers + +Like the `WORLD` option above, you can specify the URL or path of a "mod pack" +to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot. +To use this option pass the environment variable `MODPACK`, such as + + docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ... + +**NOTE:** The referenced URL must be a zip file with one or more jar files at the +top level of the zip archive. Make sure the jars are compatible with the +particular `TYPE` of server you are running. + +You may also download or copy over individual mods using the `MODS` environment variable. `MODS` contains a comma-separated list of +- URL of a jar file +- container path to a jar file +- container path to a directory containing jar files + + docker run -d -e MODS=https://www.example.com/mods/mod1.jar,/plugins/common,/plugins/special/mod2.jar ... + +### ForgeAPI usage to use non-version specific projects + +**NOTE:** This potentially could lead to unexpected behavior if the Mod receives an update with unexpected behavior. + +This is more complicated because you will be pulling/using the latest mod for the release of your game. To get started make sure you have a [CursedForge API Key](https://docs.curseforge.com/#getting-started). Then use the environmental parameters in your docker build. + +Please be aware of the following when using these options for your mods: +* Mod Release types: Release, Beta, and Alpha. +* Mod dependencies: Required and Optional +* Mod family: Fabric, Forge, and Bukkit. + +Parameters to use the ForgeAPI: + +* `MODS_FORGEAPI_KEY` - Required +* `MODS_FORGEAPI_FILE` - Required or use MODS_FORGEAPI_PROJECTIDS (Overrides MODS_FORGEAPI_PROJECTIDS) +* `MODS_FORGEAPI_PROJECTIDS` - Required or use MODS_FORGEAPI_FILE +* `MODS_FORGEAPI_RELEASES` - Default is release, Options: [Release|Beta|Alpha] +* `MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES` - Default is False, attempts to download required mods (releaseType Release) defined in Forge. +* `MODS_FORGEAPI_IGNORE_GAMETYPE` - Default is False, Allows for filtering mods on family type: FORGE, FABRIC, and BUKKIT. (Does not filter for Vanilla or custom) +* `REMOVE_OLD_FORGEAPI_MODS` - Default is False +* `REMOVE_OLD_DATAPACKS_DEPTH` - Default is 1 +* `REMOVE_OLD_DATAPACKS_INCLUDE` - Default is *.jar + +Example of expected forge api project ids, releases, and key: + +```yaml + MODS_FORGEAPI_PROJECTIDS: 306612,256717 + MODS_FORGEAPI_RELEASES: Release + MODS_FORGEAPI_KEY: $WRX... +``` + +Example of expected ForgeAPI file format. + +**Field Description**: +* `name` is currently unused, but can be used to document each entry. +* `projectId` id is the id found on the CurseForge website for a particular mod +* `releaseType` Type corresponds to forge's R, B, A icon for each file. Default Release, options are (release|beta|alpha). +* `fileName` is used for version pinning if latest file will not work for you. + +```json +[ + { + "name": "fabric api", + "projectId": "306612", + "releaseType": "release" + }, + { + "name": "fabric voice mod", + "projectId": "416089", + "releaseType": "beta" + }, + { + "name": "Biomes o plenty", + "projectId": "220318", + "fileName": "BiomesOPlenty-1.18.1-15.0.0.100-universal.jar", + "releaseType": "release" + } +] +``` + +### Generic pack files + +To install all the server content (jars, mods, plugins, configs, etc.) from a zip or tgz file, then set `GENERIC_PACK` to the container path or URL of the archive file. This can also be used to apply a CurseForge modpack that is missing a server start script and/or Forge installer. + +If multiple generic packs need to be applied together, set `GENERIC_PACKS` instead, with a comma separated list of archive file paths and/or URLs to files. + +To avoid repetition, each entry will be prefixed by the value of `GENERIC_PACKS_PREFIX` and suffixed by the value of `GENERIC_PACKS_SUFFIX`, both of which are optional. For example, the following variables + +``` +GENERIC_PACKS=configs-v9.0.1,mods-v4.3.6 +GENERIC_PACKS_PREFIX=https://cdn.example.org/ +GENERIC_PACKS_SUFFIX=.zip +``` + +would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.org/mods-v4.3.6.zip`. + +If applying large generic packs, the update can be time-consuming. To skip the update set `SKIP_GENERIC_PACK_UPDATE_CHECK` to "true". Conversely, the generic pack(s) can be forced to be applied by setting `FORCE_GENERIC_PACK_UPDATE` to "true". + +The most time consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true. + +### Mod/Plugin URL Listing File + +As an alternative to `MODS`, the variable `MODS_FILE` can be set with the path to a text file listing a mod/plugin URL on each line. For example, the following + + -e MODS_FILE=/extras/mods.txt + +would load from a file mounted into the container at `/extras/mods.txt`. That file might look like: + +```text +https://edge.forgecdn.net/files/2965/233/Bookshelf-1.15.2-5.6.40.jar +https://edge.forgecdn.net/files/2926/27/ProgressiveBosses-2.1.5-mc1.15.2.jar +# This and next line are ignored +#https://edge.forgecdn.net/files/3248/905/goblintraders-1.3.1-1.15.2.jar +https://edge.forgecdn.net/files/3272/32/jei-1.15.2-6.0.3.16.jar +https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar +``` + +!!! note + + Blank lines and lines that start with a `#` will be ignored + + [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-mods-file.yml) shows another example of using this feature. + + It is recommended to combine this option with `REMOVE_OLD_MODS=TRUE` to ensure the mods/plugins remain consistent with the file's listing. + +### Remove old mods/plugins + +When the option above is specified (`MODPACK`) you can also instruct script to +delete old mods/plugins prior to installing new ones. This behaviour is desirable +in case you want to upgrade mods/plugins from downloaded zip file. +To use this option pass the environment variable `REMOVE_OLD_MODS=TRUE`, such as + + docker run -d -e REMOVE_OLD_MODS=TRUE -e MODPACK=http://www.example.com/mods/modpack.zip ... + +!!! danger + + All content of the `mods` or `plugins` directory will be deleted +before unpacking new content from the MODPACK or MODS. diff --git a/docs/mods-and-plugins/modrinth-modpacks.md b/docs/mods-and-plugins/modrinth-modpacks.md new file mode 100644 index 00000000..9a242e5b --- /dev/null +++ b/docs/mods-and-plugins/modrinth-modpacks.md @@ -0,0 +1,23 @@ +[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader. + +The desired modpack project is specified with the `MODRINTH_PROJECT` environment variable and must be one of: + +- The project "slug", which is located in the URL shown here: + + ![](../img/modrinth-project-slug.drawio.png) +- The project ID, which is located in the bottom of the left panel, shown here + + ![](../img/modrinth-project-id.drawio.png) +- The project page URL, such as . As described below, this can further be the page URL of a modpack's version page. + +The automatic modpack version resolving can be narrowed in a few ways: + +The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_DEFAULT_VERSION_TYPE` to "release", "beta", or "alpha". + +Furthermore, the resolved modpack version can be narrowed by setting `VERSION` to a specific Minecraft version, such as "1.19.2". + +The selected version can also be narrowed to a particular mod loader by setting `MODRINTH_LOADER` to either "forge", "fabric", or "quilt". + +Instead of auto resolving, a specific version of modpack file can be specified by passing the version's page URL to `MODRINTH_PROJECT`, such as or by setting `MODRINTH_VERSION` to the version ID or number located in the Metadata section, as shown here + +![](../img/modrinth-version-id.drawio.png) diff --git a/docs/mods-and-plugins/packwiz.md b/docs/mods-and-plugins/packwiz.md new file mode 100644 index 00000000..03c61a90 --- /dev/null +++ b/docs/mods-and-plugins/packwiz.md @@ -0,0 +1,15 @@ +[packwiz](https://packwiz.infra.link/) is a CLI tool for maintaining and providing modpack definitions, with support for both CurseForge and Modrinth as sources. See the [packwiz tutorial](https://packwiz.infra.link/tutorials/getting-started/) for more information. + +To configure server mods using a packwiz modpack, set the `PACKWIZ_URL` environment variable to the location of your `pack.toml` modpack definition: + +``` +docker run -d -v /path/on/host:/data -e TYPE=FABRIC \ + -e "PACKWIZ_URL=https://example.com/modpack/pack.toml" \ + itzg/minecraft-server +``` + +packwiz modpack defitions are processed before other mod definitions (`MODPACK`, `MODS`, etc.) to allow for additional processing/overrides you may want to perform (in case of mods not available via Modrinth/CurseForge, or you do not maintain the pack). + +!!! note + + 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. diff --git a/docs/motd-example.png b/docs/motd-example.png deleted file mode 100644 index 265c66a6..00000000 Binary files a/docs/motd-example.png and /dev/null differ diff --git a/docs/related-projects.md b/docs/related-projects.md new file mode 100644 index 00000000..f18823c2 --- /dev/null +++ b/docs/related-projects.md @@ -0,0 +1,31 @@ +### [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server) + +Docker image that runs a Minecraft Bedrock server. + +### [mc-router](https://github.com/itzg/mc-router) + +Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image. + +### [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/) + +Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall + +### [itzg/mc-backup](https://github.com/itzg/docker-mc-backup) + +Docker image that runs as a side-car container to backup world data. + +### [rcon-cli](https://github.com/itzg/rcon-cli) + +A tool that is bundled with this image to provide CLI access to an RCON endpoint. + +### [mc-monitor](https://github.com/itzg/mc-monitor) + +A tool that is bundled with this image that provides health checks and metrics reporting, such as a Prometheus exporter or a telegraf data source. + +### [mc-image-helper](https://github.com/itzg/mc-image-helper) + +A tool that is bundled with this image to provide complex, re-usable preparation operations. + +### [itzg/rcon](https://github.com/itzg/docker-rcon-web-admin) + +An image that dockerizes [rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin). diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..4c574034 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,9 @@ +mkdocs +mkdocs-material-extensions +mkdocs-material +mkdocs-autorefs +mkdocstrings +mkdocs-literate-nav +mdx-gh-links +mkdocs-click +mkdocs-static-i18n \ No newline at end of file diff --git a/docs/server-types/bukkit-spigot.md b/docs/server-types/bukkit-spigot.md new file mode 100644 index 00000000..e3410724 --- /dev/null +++ b/docs/server-types/bukkit-spigot.md @@ -0,0 +1,40 @@ +Enable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT` to your command-line. + +``` +docker run -d -v /path/on/host:/data \ + -e TYPE=SPIGOT \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server +``` + +If the downloaded server jar is corrupted, set `FORCE_REDOWNLOAD` to "true" to force a re-download during next container startup. After successfully re-downloading, you should remove that or set to "false". + +If you are hosting your own copy of Bukkit/Spigot you can override the download URLs with: + +- -e BUKKIT_DOWNLOAD_URL= +- -e SPIGOT_DOWNLOAD_URL= + +You can build spigot from source by adding `-e BUILD_FROM_SOURCE=true` + +Plugins can either be managed within the `plugins` subdirectory of the [data directory](../data-directory.md) or you can also [attach a `/plugins` volume](../mods-and-plugins/index.md#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up. + +[You can also auto-download plugins using `SPIGET_RESOURCES`.](../mods-and-plugins/index.md#auto-downloading-spigotmcbukkitpapermc-plugins-with-spiget) + +!!! note + + Some of the `VERSION` values are not as intuitive as you would think, so make sure to click into the version entry to find the **exact** version needed for the download. For example, "1.8" is not sufficient since their download naming expects `1.8-R0.1-SNAPSHOT-latest` exactly. + +## Alternatives + +### Canyon + +[Canyon](https://github.com/canyonmodded/canyon) is a fork of CraftBukkit for Minecraft Beta 1.7.3. It includes multiple enhancements whilst also retaining compatibility with old Bukkit plugins and mods as much as possible. + + -e VERSION=b1.7.3 -e TYPE=CANYON + +!!! note + + Only `VERSION=b1.7.3` is supported. Since that version pre-dates the health check mechanism used by this image, that will need to be disabled by setting `DISABLE_HEALTHCHECK=true`. + +By default, the latest build will be used; however, a specific build number can be selected by setting `CANYON_BUILD`, such as + + -e CANYON_BUILD=11 diff --git a/docs/server-types/fabric.md b/docs/server-types/fabric.md new file mode 100644 index 00000000..513b5557 --- /dev/null +++ b/docs/server-types/fabric.md @@ -0,0 +1,27 @@ +Enable [Fabric server](https://fabricmc.net/) mode by adding a `-e TYPE=FABRIC` to your command-line. + +``` +docker run -d -v /path/on/host:/data \ + -e TYPE=FABRIC \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server +``` + +By default, the container will install the latest [fabric server launcher](https://fabricmc.net/use/server/), using the latest [fabric-loader](https://fabricmc.net/wiki/documentation:fabric_loader) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game). + +A specific loader or launcher version other than the latest can be requested using `FABRIC_LOADER_VERSION` and `FABRIC_LAUNCHER_VERSION` respectively, such as: + +``` +docker run -d -v /path/on/host:/data ... \ + -e TYPE=FABRIC \ + -e FABRIC_LAUNCHER_VERSION=0.10.2 \ + -e FABRIC_LOADER_VERSION=0.13.1 +``` + +!!! note + + If you wish to use an alternative launcher you can: + + - Provide the path to a custom launcher jar available to the container with `FABRIC_LAUNCHER`, relative to `/data` (such as `-e FABRIC_LAUNCHER=fabric-server-custom.jar`) + - Provide the URL to a custom launcher jar with `FABRIC_LAUNCHER_URL` (such as `-e FABRIC_LAUNCHER_URL=http://HOST/fabric-server-custom.jar`) + +See the [Working with mods and plugins](../mods-and-plugins/index.md) section to set up Fabric mods and configuration. diff --git a/docs/server-types/forge.md b/docs/server-types/forge.md new file mode 100644 index 00000000..d2dd59bd --- /dev/null +++ b/docs/server-types/forge.md @@ -0,0 +1,32 @@ +Enable [Forge server](http://www.minecraftforge.net/) mode by adding a `-e TYPE=FORGE` to your command-line. + +The overall version is specified by `VERSION`, [as described in the section above](../versions/minecraft.md) and will run the recommended Forge version by default. You can also choose to run a specific Forge version with `FORGE_VERSION`, such as `-e FORGE_VERSION=14.23.5.2854`. + +``` +docker run -d -v /path/on/host:/data \ + -e TYPE=FORGE \ + -e VERSION=1.12.2 -e FORGE_VERSION=14.23.5.2854 \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server +``` + +To use a pre-downloaded Forge installer, place it in the attached `/data` directory and +specify the name of the installer file with `FORGE_INSTALLER`, such as: + +``` +docker run -d -v /path/on/host:/data ... \ + -e FORGE_INSTALLER=forge-1.11.2-13.20.0.2228-installer.jar ... +``` + +To download a Forge installer from a custom location, such as your own file repository, specify +the URL with `FORGE_INSTALLER_URL`, such as: + +``` +docker run -d -v /path/on/host:/data ... \ + -e FORGE_INSTALLER_URL=http://HOST/forge-1.11.2-13.20.0.2228-installer.jar ... +``` + +In both of the cases above, there is no need for the `VERSION` or `FORGEVERSION` variables. + +!!! note + + If an error occurred while installing Forge, it might be possible to resolve by temporarily setting `FORGE_FORCE_REINSTALL` to "true". Be sure to remove that variable after successfully starting the server. diff --git a/docs/server-types/hybrids.md b/docs/server-types/hybrids.md new file mode 100644 index 00000000..856a3044 --- /dev/null +++ b/docs/server-types/hybrids.md @@ -0,0 +1,34 @@ + + +### Magma + +A [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with + + -e TYPE=MAGMA + +!!! note + +There are limited base versions supported, so you will also need to set `VERSION`, such as "1.12.2", "1.16.5", etc. + + +### Mohist + +A [Mohist](https://github.com/MohistMC/Mohist) server can be used with + + -e TYPE=MOHIST + +!!! note + +There are limited base versions supported, so you will also need to set `VERSION`, such as "1.12.2" + +By default the latest build will be used; however, a specific build number can be selected by setting `MOHIST_BUILD`, such as + + -e VERSION=1.16.5 -e MOHIST_BUILD=374 + +### Catserver + +A [Catserver](http://catserver.moe/) type server can be used with + + -e TYPE=CATSERVER + +> **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored diff --git a/docs/server-types/others.md b/docs/server-types/others.md new file mode 100644 index 00000000..67084942 --- /dev/null +++ b/docs/server-types/others.md @@ -0,0 +1,50 @@ + +## SpongeVanilla + +Enable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your command-line. + +By default the container will run the latest `STABLE` version. +If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line. + +Beware that current [Sponge](https://www.spongepowered.org) `STABLE` versions for Minecraft 1.12 require using [the Java 8 tag](../versions/java.md): + +``` shell +docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server:java8-multiarch +``` + +You can also choose to use the `EXPERIMENTAL` branch. +Just change it with `SPONGEBRANCH`, such as: + +``` shell +$ docker run -d -v /path/on/host:/data ... \ + -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ... +``` + +## Limbo + +A [Limbo](https://github.com/LOOHP/Limbo) server can be run by setting `TYPE` to `LIMBO`. + +Configuration options with defaults: + +- `LIMBO_BUILD`=LATEST + + The `VERSION` will be ignored so locate the appropriate value from [here](https://ci.loohpjames.com/job/Limbo/) to match the version expected by clients. + +- `FORCE_REDOWNLOAD`=false +- `LIMBO_SCHEMA_FILENAME`=default.schem +- `LEVEL`="Default;${LIMBO_SCHEMA_NAME}" + +!!! note + + Instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.fandom.com/wiki/Raw_JSON_text_format#Java_Edition). If a plain string is provided, which is the default, then it gets converted into the required JSON structure. + +## Crucible + +A [Crucible](https://github.com/CrucibleMC/Crucible) server can be run by setting `TYPE` to `CRUCIBLE`. + +Configuration options with defaults: + +- `CRUCIBLE_RELEASE`=latest + +Crucible is only available for 1.7.10, so be sure to set `VERSION=1.7.10`. diff --git a/docs/server-types/paper.md b/docs/server-types/paper.md new file mode 100644 index 00000000..6ecb6d40 --- /dev/null +++ b/docs/server-types/paper.md @@ -0,0 +1,46 @@ +Enable Paper server mode by adding a `-e TYPE=PAPER` to your command-line. + +By default, the container will run the latest build of [Paper server](https://papermc.io/downloads) but you can also choose to run a specific build with `-e PAPERBUILD=205`. + + docker run -d -v /path/on/host:/data \ + -e TYPE=PAPER \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server + +If you are hosting your own copy of Paper you can override the download URL with `PAPER_DOWNLOAD_URL=`. + +If you have attached a host directory to the `/data` volume, then you can install plugins via the `plugins` subdirectory. You can also [attach a `/plugins` volume](../mods-and-plugins/index.md#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up. + +[You can also auto-download plugins using `SPIGET_RESOURCES`.](../mods-and-plugins/index.md#auto-downloading-spigotmcbukkitpapermc-plugins-with-spiget) + +## Alternatives + +### Pufferfish + +A [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) server, which is "a highly optimized Paper fork designed for large servers requiring both maximum performance, stability, and "enterprise" features." + + -e TYPE=PUFFERFISH + +!!! note + + The `VERSION` variable is used to select branch latest, 1.18, or 1.17. Use PUFFERFISH_BUILD to really select the SERVER VERSION number. + +Extra variables: +- `PUFFERFISH_BUILD=lastSuccessfulBuild` : set a specific Pufferfish build to use. Example: selecting build 47 => 1.18.1, or build 50 => 1.18.2 etc +- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded +- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the built-in [Flare](https://blog.airplane.gg/flare) profiler + +### Purpur + +A [Purpur](https://purpurmc.org/) server, which is "a drop-in replacement for Paper servers designed for configurability and new, fun, exciting gameplay features." + + -e TYPE=PURPUR + +!!! note + + The `VERSION` variable is used to lookup a build of Purpur to download + +Extra variables: +- `PURPUR_BUILD=LATEST` : set a specific Purpur build to use +- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded +- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the built-in [Flare](https://blog.airplane.gg/flare) profiler +- `PURPUR_DOWNLOAD_URL=` : set URL to download Purpur from custom URL. diff --git a/docs/server-types/quilt.md b/docs/server-types/quilt.md new file mode 100644 index 00000000..269b1d55 --- /dev/null +++ b/docs/server-types/quilt.md @@ -0,0 +1,27 @@ +Enable [Quilt server](https://quiltmc.org/) mode by adding a `-e TYPE=QUILT` to your command-line. + +``` +docker run -d -v /path/on/host:/data \ + -e TYPE=QUILT \ + -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server +``` + +By default, the container will install the latest [quilt server launcher](https://quiltmc.org/install/server/), using the latest [quilt-installer](https://github.com/QuiltMC/quilt-installer) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game). + +A specific loader or installer version other than the latest can be requested using `QUILT_LOADER_VERSION` and `QUILT_INSTALLER_VERSION` respectively, such as: + +``` +docker run -d -v /path/on/host:/data ... \ + -e TYPE=QUILT \ + -e QUILT_LOADER_VERSION=0.16.0 \ + -e QUILT_INSTALLER_VERSION=0.4.1 +``` + +!!! note + + If you wish to use an alternative launcher you can: + + - Provide the path to a custom launcher jar available to the container with `QUILT_LAUNCHER`, relative to `/data` (such as `-e QUILT_LAUNCHER=quilt-server-custom.jar`) + - Provide the URL to a custom launcher jar with `QUILT_LAUNCHER_URL` (such as `-e QUILT_LAUNCHER_URL=http://HOST/quilt-server-custom.jar`) + +See the [Working with mods and plugins](../mods-and-plugins/index.md) section to set up Quilt mods and configuration. diff --git a/docs/start-script-flow.drawio.png b/docs/start-script-flow.drawio.png deleted file mode 100644 index b2f0e89e..00000000 Binary files a/docs/start-script-flow.drawio.png and /dev/null differ diff --git a/docs/variables/index.md b/docs/variables/index.md new file mode 100644 index 00000000..6956d3ba --- /dev/null +++ b/docs/variables/index.md @@ -0,0 +1,806 @@ + +### **OS OPTIONS** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
UIDThe linux user id to run as1000⬜️
GIDThe linux group id to run as1000⬜️
MEMORYThe image declares an initial and maximum Java memory-heap limit of 1 GB.1G⬜️
INIT_MEMORYIndependently sets the initial heap size1G⬜️
MAX_MEMORYindependently sets the max heap size1G⬜️
TZYou can configure the timezone to match yours by setting the TZ environment variable. + +alternatively, you can mount: /etc/localtime:/etc/localtime:ro + +/etc/timezone:/etc/timezone:ro + 1G⬜️
ENABLE_ROLLING_LOGSBy default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by setting this to truefalse⬜️
ENABLE_JMXTo enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable ENABLE_JMX=truefalse⬜️
JMX_HOSTIf JMX is enabled, set JMX_HOST to the IP/host running the Docker container, and add a port forwarding of TCP port 7091⬜️
USE_AIKAR_FLAGSAikar has done some research into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrentlyfalse⬜️
JVM_OPTSGeneral JVM options can be passed to the Minecraft Server invocation by passing a JVM_OPTS environment variable. The JVM requires -XX options to precede -X options, so those can be declared in JVM_XX_OPTS. Both variables are space-delimited, raw JVM arguments⬜️
JVM_XX_OPTSGeneral JVM options can be passed to the Minecraft Server invocation by passing a JVM_OPTS environment variable. The JVM requires -XX options to precede -X options, so those can be declared in JVM_XX_OPTS. Both variables are space-delimited, raw JVM arguments⬜️
JVM_DD_OPTSAs a shorthand for passing several system properties as -D arguments, you can instead pass a comma separated list of name=value or name:value pairs with JVM_DD_OPTS. (The colon syntax is provided for management platforms like Plesk that don't allow = inside a value.)⬜️
EXTRA_ARGSArguments that would usually be passed to the jar file (those which are written after the filename)⬜️
LOG_TIMESTAMP To include the timestamp with each log set to truefalse⬜️
+ +### **SERVER** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
TYPEThe server typeVANILLA⬜️
EULAYou MUST set this to true ✅
VERSIONThe minecraft versionLATEST⬜️
MOTDSet the server log in message.⬜️
DIFFICULTYThe difficulty level. Available values: peaceful,easy,normal,hardeasy⬜️
ICONThe url or file path for the icon image to use for the server. It will be downloaded, scaled, and converted to the proper format.⬜️
OVERRIDE_ICONThe server icon which has been set doesn't get overridden by default. Set this to TRUE to override the iconFALSE⬜️
MAX_PLAYERSThe maximum number of players that can join the server.20⬜️
MAX_WORLD_SIZEThe maximum possible size in blocks, expressed as a radius.⬜️
ALLOW_NETHERAllows players to travel to the Nethertrue⬜️
ANNOUNCE_PLAYER_ACHIEVEMENTSAllows server to announce when a player gets an achievement.true⬜️
ENABLE_COMMAND_BLOCKEnables the command blocks.⬜️
FORCE_GAMEMODEForce players to join in the default game mode.false⬜️
GENERATE_STRUCTURESDefines whether structures (such as villages) will be generated.true⬜️
HARDCOREIf set to true, players will be set to spectator mode if they die.false⬜️
SNOOPER_ENABLEDIf set to false, the server will not send data to snoop.minecraft.net server.true⬜️
MAX_BUILD_HEIGHTThe maximum height in which building is allowed. Terrain may still naturally generate above a low height limit.256⬜️
SPAWN_ANIMALSDetermines if animals will be able to spawn.true⬜️
SPAWN_MONSTERSDetermines if monsters will be spawned.true⬜️
SPAWN_NPCSDetermines if villagers will be spawned.true⬜️
SPAWN_PROTECTIONSets the area that non-ops can not edit (0 to disable)⬜️
VIEW_DISTANCESets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). It determines the server-side viewing distance.⬜️
SEEDSets the seed to create the Minecraft world. If you use a negative number, make sure that it is in quotes.⬜️
MODEMinecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the standard numerical values or the shortcut values:
+
    +
  • creative
    • +
  • survival
    • +
  • adventure
    • +
  • spectator(minecraft 1.8 or later)
    • +
⬜️
PVPBy default, servers are created with player-vs-player (PVP) mode enabled.true⬜️
LEVEL_TYPEBy default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to an expected type listed here. + minecraft:default⬜️
GENERATOR_SETTINGSFor some of the level types, GENERATOR_SETTINGS can be used to further customize the world generation as described here.⬜️
LEVELYou can either switch between world saves or run multiple containers with different saves by using the LEVEL optionworld⬜️
ONLINE_MODEBy default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate playerstrue⬜️
ALLOW_FLIGHTAllows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.FALSE⬜️
SERVER_NAMEThe server name⬜️
SERVER_PORTOnly change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.⬜️
PLAYER_IDLE_TIMEOUTplayer-idle-timeout⬜️
ENABLE_JMXenable-jmx-monitoring⬜️
SYNC_CHUNK_WRITESsync-chunk-writes⬜️
ENABLE_STATUSenable-status⬜️
ENTITY_BROADCAST_RANGE_PERCENTAGEentity-broadcast-range-percentage⬜️
FUNCTION_PERMISSION_LEVELfunction-permission-level⬜️
NETWORK_COMPRESSION_THRESHOLDnetwork-compression-threshold⬜️
OP_PERMISSION_LEVELop-permission-level⬜️
PREVENT_PROXY_CONNECTIONSprevent-proxy-connections⬜️
USE_NATIVE_TRANSPORTuse-native-transport⬜️
SIMULATION_DISTANCEsimulation-distance⬜️
EXEC_DIRECTLYIf you would like to docker attach to the Minecraft server console with color and interactive capabilities, then set to truefalse⬜️
STOP_SERVER_ANNOUNCE_DELAYTo allow time for players to finish what they're doing during a graceful server shutdown, set STOP_SERVER_ANNOUNCE_DELAY to a number of seconds to delay after an announcement is posted by the server.⬜️
PROXYYou may configure the use of an HTTP/HTTPS proxy by passing the proxy's URLfalse⬜️
CONSOLESome older versions (pre-1.14) of Spigot required --noconsole to be passed when detaching stdinTRUE⬜️
GUISome older servers get confused and think that the GUI interface is enabled.TRUE⬜️
STOP_DURATIONWhen the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish.60⬜️
SETUP_ONLYIf you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting this to truefalse⬜️
USE_FLARE_FLAGSTo enable the JVM flags required to fully support the Flare profiling suite.⬜️
USE_SIMD_FLAGSSupport for optimized SIMD operationfalse⬜️
+ +### **CUSTOM RESOURCE PACK** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
RESOURCE_PACKA link to a custom resource pack⬜️
RESOURCE_PACK_SHA1The checksum for the custom resource pack⬜️
RESOURCE_PACK_ENFORCEEnforce the resource pack on clientsFALSE⬜️
+ +### **WHITELIST** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
ENABLE_WHITELISTEnable the whitelist to manually manage the whitelistfalse⬜️
WHITELISTA list of usernames and/or UUIDs separated by comma⬜️
WHITELIST_FILEA url or file path to a whitelist json formatted file.⬜️
OVERRIDE_WHITELISTEnforce regeneration of the whitelist on each server startup.false⬜️
+ +### **RCON** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
ENABLE_RCONShould RCON be enabledtrue⬜️
RCON_PASSWORDYou MUST change this valueminecraft✅
RCON_PORTThe port for RCON25575⬜️
BROADCAST_RCON_TO_OPSShould RCON be enabledfalse⬜️
RCON_CMDS_STARTUPRCON commands can be configured to execute when the server starts, a client connects, or a client disconnects⬜️
RCON_CMDS_ON_CONNECTRCON commands can be configured to execute when the server starts, a client connects, or a client disconnects⬜️
RCON_CMDS_ON_DISCONNECTRCON commands can be configured to execute when the server starts, a client connects, or a client disconnects⬜️
RCON_CMDS_LAST_DISCONNECTRCON commands can be configured to execute when the server starts, a client connects, or a client disconnects⬜️
RCON_CMDS_STARTUPRCON commands can be configured to execute when the server starts, a client connects, or a client disconnects⬜️
+ +### **AUTOPAUSE** + +!!! note + + Autopause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
ENABLE_AUTOPAUSEEnable the Autopause functionalityFALSE⬜️
AUTOPAUSE_TIMEOUT_ESTdescribes the time between the last client disconnect and the pausing of the process3600⬜️
AUTOPAUSE_TIMEOUT_INITdescribes the time between server start and the pausing of the process, when no client connects in-between600⬜️
AUTOPAUSE_TIMEOUT_KNdescribes the time between knocking of the port (e.g. by the main menu ping) and the pausing of the process, when no client connects in-between120⬜️
AUTOPAUSE_PERIODdescribes period of the daemonized state machine, that handles the pausing of the process10⬜️
AUTOPAUSE_KNOCK_INTERFACEDescribes the interface passed to the knockd daemon. If the default interface does not work, run the ifconfig command inside the container and derive the interface receiving the incoming connection from its output. The passed interface must exist inside the container. Using the loopback interface (lo) does likely not yield the desired results.eth0⬜️
DEBUG_AUTOPAUSEAdds additional debugging output for AutoPausefalse⬜️
+ + + +### **AUTOSTOP** + +!!! note + + AutoStop function is incompatible with the Autopause functionality, as they basically cancel out each other. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
ENABLE_AUTOSTOPEnable the AutoStop functionalityFALSE⬜️
AUTOSTOP_TIMEOUT_ESTdescribes the time between the last client disconnect and the stopping of the server3600⬜️
AUTOSTOP_TIMEOUT_INITdescribes the time between server start and the stopping of the server, when no client connects in-between1800⬜️
AUTOSTOP_PERIODdescribes period of the daemonized state machine, that handles the stopping of the serve10⬜️
DEBUG_AUTOSTOPAdds additional logging for AutoStopfalse⬜️
+ + +### **CURSEFORGE** + +!!! note + + A CurseForge API key is required to use a CurseForge type server. Go to their [developer console](https://console.curseforge.com/), generate an API key, and set the environment variable CF_API_KEY + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NAMEDESCRIPTIONDEFAULTREQUIRED
CF_API_KEYYOUR CurseForge (Eternal) API Key.✅
CF_PAGE_URLPass a page URL to the modpack or a specific file⬜️
CF_SLUGInstead of a URL, the modpack slug can be provided.⬜️
CF_FILE_IDThe mod curseforge numerical ID.⬜️
CF_FILENAME_MATCHERSpecify a substring to match the desired filename⬜️
CF_EXCLUDE_INCLUDE_FILEGlobal and per modpack exclusions can be declared in a JSON file and referenced with this variable.

By default, the file bundled with the image will be used, but can be disabled by setting this to an empty string. The schema of this file is documented here.		⬜️
CF_EXCLUDE_MODSMods can be excluded by passing a comma or space delimited list of project slugs or IDs⬜️
CF_FORCE_INCLUDE_MODSMods can be included by passing a comma or space delimited list of project slugs or IDs⬜️
CF_FORCE_SYNCHRONIZEForces the excludes/includes to be re-evaluated⬜️
CF_SET_LEVEL_FROMSome modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the LEVEL to the resulting saves directory by setting this to either: +
    +
  • WORLD_FILE
    • +
  • OVERRIDES
    • +
⬜️
CF_PARALLEL_DOWNLOADSspecify how many parallel mod downloads to perform4⬜️
CF_OVERRIDES_SKIP_EXISTINGif set, files in the overrides that already exist in the data directory are skipped. world data is always skipped, if present.false⬜️
+ + + diff --git a/docs/versions/java.md b/docs/versions/java.md new file mode 100644 index 00000000..d7532204 --- /dev/null +++ b/docs/versions/java.md @@ -0,0 +1,46 @@ +## Running Minecraft server on different Java version + +!!! note + + For Forge versions less than 1.18, you _must_ use the `java8-multiarch` (or other java8) image tag. + +When using the image `itzg/minecraft-server` without a tag, the `latest` image tag is implied from the table below. To use a different version of Java, please use an alternate tag to run your Minecraft server container. + +| Tag name | Java version | Linux | JVM Type | Architecture | +|-------------------|--------------|--------|-------------|-------------------| +| latest | 17 | Ubuntu | Hotspot | amd64,arm64,armv7 | +| java8 | 8 | Alpine | Hotspot | amd64 | +| java8-jdk | 8 | Ubuntu | Hotspot+JDK | amd64 | +| java8-multiarch | 8 | Ubuntu | Hotspot | amd64,arm64,armv7 | +| java8-openj9 | 8 | Debian | OpenJ9 | amd64 | +| java8-graalvm-ce | 8 | Oracle | GraalVM CE | amd64 | +| java11 | 11 | Ubuntu | Hotspot | amd64,arm64,armv7 | +| java11-jdk | 11 | Ubuntu | Hotspot+JDK | amd64,arm64,armv7 | +| java11-openj9 | 11 | Debian | OpenJ9 | amd64 | +| java17 | 17 | Ubuntu | Hotspot | amd64,arm64,armv7 | +| java17-jdk | 17 | Ubuntu | Hotspot+JDK | amd64,arm64,armv7 | +| java17-openj9 | 17 | Debian | OpenJ9 | amd64 | +| java17-graalvm-ce | 17 | Oracle | GraalVM CE | amd64,arm64 | +| java17-alpine | 17 | Alpine | Hotspot | amd64 | +| java19 | 19 | Ubuntu | Hotspot | amd64,arm64,armv7 | + +For example, to use Java version 8 on any supported architecture: + + docker run --name mc itzg/minecraft-server:java8-multiarch + +!!! note + + Keep in mind that some versions of Minecraft server, such as Forge before 1.17, can't work on the newest versions of Java. Instead, one of the Java 8 images should be used. Also, FORGE doesn't support openj9 JVM implementation. + + Some versions of vanilla Minecraft, such as 1.10, also do not run correctly with Java 17. If in doubt, use `java8-multiarch` for any version less than 1.17. + +### Deprecated Image Tags + +The following image tags have been deprecated and are no longer receiving updates: + +- adopt13 +- adopt14 +- adopt15 +- openj9-nightly +- multiarch-latest +- java16/java16-openj9 diff --git a/docs/versions/minecraft.md b/docs/versions/minecraft.md new file mode 100644 index 00000000..4eeabd18 --- /dev/null +++ b/docs/versions/minecraft.md @@ -0,0 +1,25 @@ +To use a different Minecraft version, pass the `VERSION` environment variable (case sensitive), which can have the value + +- LATEST (the default) +- SNAPSHOT +- or a specific version, such as "1.7.9" + +For example, to use the latest snapshot: + +``` +docker run -d -e VERSION=SNAPSHOT ... +``` + +or a specific version: + +``` +docker run -d -e VERSION=1.7.9 ... +``` + +When using "LATEST" or "SNAPSHOT" an upgrade can be performed by simply restarting the container. +During the next startup, if a newer version is available from the respective release channel, then +the new server jar file is downloaded and used. + +!!! note + + Over time you might see older versions of the server jar remain in the `/data` directory. It is safe to remove those. diff --git a/docs/world-copy-compose-project.drawio.png b/docs/world-copy-compose-project.drawio.png deleted file mode 100644 index 64976e9c..00000000 Binary files a/docs/world-copy-compose-project.drawio.png and /dev/null differ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..d0ac63aa --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,75 @@ +--- +site_name: Minecraft Server on Docker +site_url: https://itzg.github.io/docker-minecraft-docs +site_description: Documentation for Minecraft Server on Docker +repo_url: https://github.com/itzg/docker-minecraft-docs +edit_uri: blob/main/docs/ +theme: + name: material + features: + - navigation.instant + - navigation.tracking + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.expand + - navigation.top + - navigation.indexes + locale: en + + highlightjs: true + hljs_languages: + - yaml + - bash + - java + - docker + - shell + - json + +extra_css: + - css/extra.css +markdown_extensions: + - admonition + - toc: + permalink:  + - attr_list + - def_list + - tables + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.details + - pymdownx.snippets + - pymdownx.superfences + - mdx_gh_links: + user: camalot + repo: mkdocs-test + - mkdocs-click +copyright: Copyright © itzg 2023. +plugins: + - search + - autorefs + - literate-nav: + nav_file: README.md + implicit_index: true + - mkdocstrings: + handlers: + python: + options: + docstring_section_style: list + members_order: source + show_root_heading: true + show_source: false + show_signature_annotations: true + # https://github.com/ultrabug/mkdocs-static-i18n + - i18n: + default_language: en + languages: + en: + name: English + build: true diff --git a/notes/Going from docker run to compose.drawio.png b/notes/Going from docker run to compose.drawio.png new file mode 100644 index 00000000..e69de29b diff --git a/docs/Minecraft server containment.xml b/notes/Minecraft server containment.xml similarity index 100% rename from docs/Minecraft server containment.xml rename to notes/Minecraft server containment.xml diff --git a/notes/start-script-flow.drawio.png b/notes/start-script-flow.drawio.png new file mode 100644 index 00000000..e69de29b