{"id":106131,"url":"https://github.com/awesome-release/docker-minecraft-server","name":"docker-minecraft-server","description":"Docker minecraft server","projects_count":33,"last_synced_at":"2026-06-04T03:00:21.262Z","repository":{"id":55924098,"uuid":"316080412","full_name":"awesome-release/docker-minecraft-server","owner":"awesome-release","description":"Docker minecraft server","archived":false,"fork":false,"pushed_at":"2020-12-17T04:59:59.000Z","size":945,"stargazers_count":10,"open_issues_count":0,"forks_count":28,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-05-18T15:04:36.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/awesome-release.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-26T00:00:56.000Z","updated_at":"2025-05-03T16:39:43.000Z","dependencies_parsed_at":"2022-08-15T09:31:17.942Z","dependency_job_id":null,"html_url":"https://github.com/awesome-release/docker-minecraft-server","commit_stats":null,"previous_names":[],"tags_count":100,"template":false,"template_full_name":null,"purl":"pkg:github/awesome-release/docker-minecraft-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awesome-release%2Fdocker-minecraft-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awesome-release%2Fdocker-minecraft-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awesome-release%2Fdocker-minecraft-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awesome-release%2Fdocker-minecraft-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/awesome-release","download_url":"https://codeload.github.com/awesome-release/docker-minecraft-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awesome-release%2Fdocker-minecraft-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33887124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-04T02:00:06.755Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"created_at":"2026-01-12T16:14:52.754Z","updated_at":"2026-06-04T03:00:21.262Z","primary_language":null,"list_of_lists":false,"displayable":true,"categories":["Using Docker Compose","Running a Magma server","Verified to work in Release","Healthcheck","Deployment Templates and Examples","EULA Support","Looking for a Bedrock Dedicated Server","Interacting with the server","Autopause (experimental)","Running a Paper server","Running a Tuinity server","Running a Mohist server","Running a Catserver type server","Running a server with a Feed the Beast modpack","Running a server with a CurseForge modpack","Running a Fabric Server","Server configuration","Running a Forge Server","Miscellaneous Options"],"sub_categories":["Using separate mounts","Replacing variables inside configs","Amazon Web Services (AWS) Deployment","Description","Helm Charts","Examples","Environment Variables:","Fixing \"unable to launch forgemodloader\"","Level Type and Generator Settings","Example","Enable Aikar's Flags"],"readme":"## Verified to work in Release\nThis project is based on [https://github.com/itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server)\n\nNo modifications were necessary for this project to run in Release. However, in the Release Application Template it is necessary to adjust a few things. \n\nFirst, create an ELB to expose port 25565 with a simple hostname under the minecraft service. The minecraft service section of your Application Template should look like this:\n\n```\nservices:\n- name: minecraft\n  image: itzg/minecraft-server\n  ports:\n  - port: '25565'\n    type: node_port\n    target_port: '25565'\n    loadbalancer: true\n  hostname: minecraft-${env_id}-lb-${domain}\n```\nThis will expose port 25565 directly via an ELB to the Internet.\n\nYou should also increase the memory available for this container in Release by editing the resources section of your Applicaiton Template. In this example I've used 3Gb.\n\n```\nresources:\n  cpu:\n    limits: 1000m\n    requests: 100m\n  memory:\n    limits: 3Gi\n    requests: 100Mi\n  replicas: 1\n```\nFor more information on editing a Release Application Template, please refer to the documentation: [Release Application Template Documentation](https://docs.releaseapp.io/reference-guide/application-settings/application-template). \n\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-server.svg)](https://hub.docker.com/r/itzg/minecraft-server/)\n[![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?maxAge=2592000)](https://hub.docker.com/r/itzg/minecraft-server/)\n[![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-server.svg)](https://github.com/itzg/docker-minecraft-server/issues)\n[![Discord](https://img.shields.io/discord/660567679458869252?label=Discord\u0026logo=discord)](https://discord.gg/DXfKpjB)\n[![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions)\n[![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)\n\nThis docker image provides a Minecraft Server that will automatically download the latest stable\nversion at startup. You can also run/upgrade to any specific version or the\nlatest snapshot. See the _Versions_ section below for more information.\n\nTo simply use the latest stable version, run\n\n    docker run -d -p 25565:25565 --name mc -e EULA=TRUE itzg/minecraft-server\n\nwhere the standard server port, 25565, will be exposed on your host machine.\n\nIf you want to serve up multiple Minecraft servers or just use an alternate port,\nchange the host-side port mapping such as\n\n    docker run -p 25566:25565 ...\n\nwill serve your Minecraft server on your host's port 25566 since the `-p` syntax is\n`host-port`:`container-port`.\n\nSpeaking of multiple servers, it's handy to give your containers explicit names using `--name`, such as\n\n    docker run -d -p 25565:25565 --name mc itzg/minecraft-server\n\nWith that you can easily view the logs, stop, or re-start the container:\n\n    docker logs -f mc\n        ( Ctrl-C to exit logs action )\n\n    docker stop mc\n\n    docker start mc\n*Be sure to always include `-e EULA=TRUE` in your commands, as Mojang/Microsoft requires EULA acceptance.*\n\n## Looking for a Bedrock Dedicated Server\n\nFor Minecraft clients running on consoles, mobile, or native Windows, you'll need to\nuse this image instead:\n\n[itzg/minecraft-bedrock-server](https://hub.docker.com/r/itzg/minecraft-bedrock-server)\n\n## Interacting with the server\n\n[RCON](http://wiki.vg/RCON) is enabled by default, so you can `exec` into the container to\naccess the Minecraft server console:\n\n```\ndocker exec -i mc rcon-cli\n```\n\nNote: The `-i` is required for interactive use of rcon-cli.\n\nTo run a simple, one-shot command, such as stopping a Minecraft server, pass the command as\narguments to `rcon-cli`, such as:\n\n```\ndocker exec mc rcon-cli stop\n```\n\n_The `-i` is not needed in this case._\n\nIn order to attach and interact with the Minecraft server, add `-it` when starting the container, such as\n\n    docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server\n\nWith that you can attach and interact at any time using\n\n    docker attach mc\n\nand then Control-p Control-q to **detach**.\n\nFor remote access, configure your Docker daemon to use a `tcp` socket (such as `-H tcp://0.0.0.0:2375`)\nand attach from another machine:\n\n    docker -H $HOST:2375 attach mc\n\nUnless you're on a home/private LAN, you should [enable TLS access](https://docs.docker.com/articles/https/).\n\n## EULA Support\n\nMojang now requires accepting the [Minecraft EULA](https://account.mojang.com/documents/minecraft_eula). To accept add\n\n        -e EULA=TRUE\n\nsuch as\n\n        docker run -d -it -e EULA=TRUE -p 25565:25565 --name mc itzg/minecraft-server\n\n## Timezone Configuration\n\nYou can configure the timezone to match yours by setting the `TZ` environment variable:\n\n        -e TZ=Europe/London\n\nsuch as:\n\n        docker run -d -it -e TZ=Europe/London -p 25565:25565 --name mc itzg/minecraft-server\n\nOr mounting `/etc/timezone` as readonly (not supported on Windows):\n\n        -v /etc/timezone:/etc/timezone:ro\n\nsuch as:\n\n        docker run -d -it -v /etc/timezone:/etc/timezone:ro -p 25565:25565 --name mc itzg/minecraft-server\n\n## Attaching data directory to host filesystem\n\nIn order to readily access the Minecraft data, use the `-v` argument\nto map a directory on your host machine to the container's `/data` directory, such as:\n\n    docker run -d -v /path/on/host:/data ...\n\nWhen attached in this way you can stop the server, edit the configuration under your attached `/path/on/host`\nand start the server again with `docker start CONTAINERID` to pick up the new configuration.\n\n## Versions\n\nTo use a different Minecraft version, pass the `VERSION` environment variable, which can have the value\n\n- LATEST (the default)\n- SNAPSHOT\n- or a specific version, such as \"1.7.9\"\n\nFor example, to use the latest snapshot:\n\n    docker run -d -e VERSION=SNAPSHOT ...\n\nor a specific version:\n\n    docker run -d -e VERSION=1.7.9 ...\n\nWhen using \"LATEST\" or \"SNAPSHOT\" an upgrade can be performed by simply restarting the container.\nDuring the next startup, if a newer version is available from the respective release channel, then\nthe new server jar file is downloaded and used. _NOTE: over time you might see older versions of\nthe server jar remain in the `/data` directory. It is safe to remove those._\n\n## Running Minecraft server on different Java version\n\nTo use a different version of Java, please use a docker tag to run your Minecraft server.\n\n| Tag name       | Description                                 | Linux        |\n| -------------- | ------------------------------------------- | ------------ |\n| latest         | **Default**. Uses Java version 8 update 212 | Alpine Linux |\n| adopt14        | Uses Java version 14 latest update          | Alpine Linux |\n| adopt13        | Uses Java version 13 latest update          | Alpine Linux |\n| adopt11        | Uses Java version 11 latest update          | Alpine Linux |\n| openj9         | Uses Eclipse OpenJ9 JVM                     | Alpine Linux |\n| openj9-nightly | Uses Eclipse OpenJ9 JVM testing builds      | Alpine Linux |\n| multiarch      | Uses Java version 8 latest update           | Debian Linux |\n\nFor example, to use a Java version 13:\n\n    docker run --name mc itzg/minecraft-server:adopt13\n\nKeep in mind that some versions of Minecraft server can't work on the newest versions of Java. Also, FORGE doesn't support openj9 JVM implementation.\n\n## Healthcheck\n\nThis image contains [mc-monitor](https://github.com/itzg/mc-monitor) and uses\nits `status` command to continually check on the container's. That can be observed\nfrom the `STATUS` column of `docker ps`\n\n```\nCONTAINER ID        IMAGE               COMMAND             CREATED             STATUS                    PORTS                                 NAMES\nb418af073764        mc                  \"/start\"            43 seconds ago      Up 41 seconds (healthy)   0.0.0.0:25565-\u003e25565/tcp, 25575/tcp   mc\n```\n\nYou can also query the container's health in a script friendly way:\n\n```\n\u003e docker container inspect -f \"{{.State.Health.Status}}\" mc\nhealthy\n```\n\nSome 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`.\n\n## Autopause (experimental)\n\n### Description\n\n\u003e EXPERIMENTAL: this feature only works with default bridge networking using official Docker distributions. Host networking and container management software, such as Portainer, and NAS solutions do not seem to provide compatible networking.\n\nThere 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\u0026page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-593606)).\n\nAn 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.\n\nOf course, even loaded chunks are not ticked when the process is stopped.\n\nFrom 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 correctly.\n\nOn 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.\n\nA starting, example compose file has been provided in [examples/docker-compose-autopause.yml](examples/docker-compose-autopause.yml).\n\n### Enabling Autopause\n\nEnable the Autopause functionality by setting:\n\n```\n-e ENABLE_AUTOPAUSE=TRUE\n```\n\nThere are 4 more environment variables that define the behaviour:\n* `AUTOPAUSE_TIMEOUT_EST`, default `3600` (seconds)\ndescribes the time between the last client disconnect and the pausing of the process (read as timeout established)\n* `AUTOPAUSE_TIMEOUT_INIT`, default `600` (seconds)\ndescribes the time between server start and the pausing of the process, when no client connects inbetween (read as timeout initialized)\n* `AUTOPAUSE_TIMEOUT_KN`, default `120` (seconds)\ndescribes 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)\n* `AUTOPAUSE_PERIOD`, default `10` (seconds)\ndescribes period of the daemonized state machine, that handles the pausing of the process (resuming is done independently)\n\n## Deployment Templates and Examples\n\n### Helm Charts\n\n- [stable/minecraft](https://hub.helm.sh/charts/stable/minecraft) ([chart source](https://github.com/helm/charts/tree/master/stable/minecraft))\n- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)\n\n### Examples\n\nThe [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.\n\n### Amazon Web Services (AWS) Deployment\n\nIf 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.\n\n## Running a Forge Server\n\nEnable Forge server mode by adding a `-e TYPE=FORGE` to your command-line.\nBy default the container will run the `RECOMMENDED` version of [Forge server](http://www.minecraftforge.net/wiki/)\nbut you can also choose to run a specific version with `-e FORGEVERSION=10.13.4.1448`.\n\n    $ docker run -d -v /path/on/host:/data \\\n        -e TYPE=FORGE -e FORGEVERSION=10.13.4.1448 \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\nTo use a pre-downloaded Forge installer, place it in the attached `/data` directory and\nspecify the name of the installer file with `FORGE_INSTALLER`, such as:\n\n    $ docker run -d -v /path/on/host:/data ... \\\n        -e FORGE_INSTALLER=forge-1.11.2-13.20.0.2228-installer.jar ...\n\nTo download a Forge installer from a custom location, such as your own file repository, specify\nthe URL with `FORGE_INSTALLER_URL`, such as:\n\n    $ docker run -d -v /path/on/host:/data ... \\\n        -e FORGE_INSTALLER_URL=http://HOST/forge-1.11.2-13.20.0.2228-installer.jar ...\n\nIn both of the cases above, there is no need for the `VERSION` or `FORGEVERSION` variables.\n\nIn order to add mods, you have two options.\n\n### Using the /data volume\n\nThis is the easiest way if you are using a persistent `/data` mount.\n\nTo do this, you will need to attach the container's `/data` directory\n(see \"Attaching data directory to host filesystem”).\nThen, you can add mods to the `/path/on/host/mods` folder you chose. From the example above,\nthe `/path/on/host` folder contents look like:\n\n```\n/path/on/host\n├── mods\n│   └── ... INSTALL MODS HERE ...\n├── config\n│   └── ... CONFIGURE MODS HERE ...\n├── ops.json\n├── server.properties\n├── whitelist.json\n├── worlds\n│   └── ... PLACE MAPS IN THEIR OWN FOLDERS HERE ...\n└── ...\n```\n\nProviding a presistent `/data` mount is a good idea, both to persist the game world and to allow for the manual configuration which is sometimes needed.\n\nFor instance, imagine a scenario when the initial launch has completed, but you now want to change the worldmap for your server.  \n\nAssuming you have a shared directory to your container, you can then (after first launch) drag and drop your premade maps or worlds into the `\\worlds\\` directory.  **Note:** each world should be placed in its own folder under the `\\worlds\\` directory.  \n\nOnce your maps are in the proper path, you can then specify which map the server uses by changing the `level-name` value in `server.properties` to match the name of your map.\n\nIf you add mods or make changes to `server.properties` while the container is running, you'll need to restart it to pick those\nup:\n\n    docker stop mc\n    docker start mc\n\n### Using separate mounts\n\nThis is the easiest way if you are using an ephemeral `/data` filesystem,\nor downloading a world with the `WORLD` option.\n\nThere are two additional volumes that can be mounted; `/mods` and `/config`.\nAny files in either of these filesystems will be copied over to the main\n`/data` filesystem before starting Minecraft. If you want old mods to be removed as the `/mods` content is updated, then add `-e REMOVE_OLD_MODS=TRUE`.\n\nThis works well if you want to have a common set of modules in a separate\nlocation, but still have multiple worlds with different server requirements\nin either persistent volumes or a downloadable archive.\n\n\n\n### Replacing variables inside configs\n\nSometimes you have mods or plugins that require configuration information that is only available at runtime.\nFor example if you need to configure a plugin to connect to a database,\nyou don't want to include this information in your Git repository or Docker image.\nOr maybe you have some runtime information like the server name that needs to be set\nin your config files after the container starts.\n\nFor those cases there is the option to replace defined variables inside your configs\nwith environment variables defined at container runtime.\n\nIf you set the enviroment variable `REPLACE_ENV_VARIABLES` to `TRUE` the startup script\nwill go thru all files inside your `/data` volume and replace variables that match your\ndefined environment variables. Variables that you want to replace need to be wrapped\ninside `${YOUR_VARIABLE}` curly brackets and prefixed with a dollar sign. This is the regular\nsyntax for enviromment variables inside strings or config files.\n\nOptionally you can also define a prefix to only match predefined environment variables.\n\n`ENV_VARIABLE_PREFIX=\"CFG_\"` \u003c-- this is the default prefix\n\nIf you want use file for value (like when use secrets) you can add suffix `_FILE` to your variable name (in  run command).\n\nThere are some limitations to what characters you can use.\n\n| Type  | Allowed Characters  |\n| ----- | ------------------- |\n| Name  | `0-9a-zA-Z_-`       |\n| Value | `0-9a-zA-Z_-:/=?.+` |\n\nVariables will be replaced in files with the following extensions:\n`.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`.\n\nSpecific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`.\n\nPaths can be excluded by listing them in the variable `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. Path\nexcludes are recursive. Here is an example:\n```\nREPLACE_ENV_VARIABLES_EXCLUDE_PATHS=\"/data/plugins/Essentials/userdata /data/plugins/MyPlugin\"\n```\n\nHere is a full example where we want to replace values inside a `database.yml`.\n\n```yml\n\n---\ndatabase:\n  host: ${CFG_DB_HOST}\n  name: ${CFG_DB_NAME}\n  password: ${CFG_DB_PASSWORD}\n```\n\nThis is how your `docker-compose.yml` file could look like:\n\n```yml\nversion: \"3\"\n# Other docker-compose examples in /examples\n\nservices:\n  minecraft:\n    image: itzg/minecraft-server\n    ports:\n      - \"25565:25565\"\n    volumes:\n      - \"mc:/data\"\n    environment:\n      EULA: \"TRUE\"\n      ENABLE_RCON: \"true\"\n      RCON_PASSWORD: \"testing\"\n      RCON_PORT: 28016\n      # enable env variable replacement\n      REPLACE_ENV_VARIABLES: \"TRUE\"\n      # define an optional prefix for your env variables you want to replace\n      ENV_VARIABLE_PREFIX: \"CFG_\"\n      # and here are the actual variables\n      CFG_DB_HOST: \"http://localhost:3306\"\n      CFG_DB_NAME: \"minecraft\"\n      CFG_DB_PASSWORD_FILE: \"/run/secrets/db_password\"\n    restart: always\n  rcon:\n    image: itzg/rcon\n    ports:\n      - \"4326:4326\"\n      - \"4327:4327\"\n    volumes:\n      - \"rcon:/opt/rcon-web-admin/db\"\n\nvolumes:\n  mc:\n  rcon:\n\nsecrets:\n  db_password:\n    file: ./db_password\n```\n\nThe content of `db_password`:\n\n    ug23u3bg39o-ogADSs\n    \n## Running a Bukkit/Spigot server\n\nEnable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT` to your command-line.\n\n    docker run -d -v /path/on/host:/data \\\n        -e TYPE=SPIGOT \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\nIf you are hosting your own copy of Bukkit/Spigot you can override the download URLs with:\n\n- -e BUKKIT_DOWNLOAD_URL=\u003curl\u003e\n- -e SPIGOT_DOWNLOAD_URL=\u003curl\u003e\n\nYou can build spigot from source by adding `-e BUILD_FROM_SOURCE=true`\n\nIf you have attached a host directory to the `/data` volume, then you can install plugins within the `plugins` subdirectory. You can also [attach a `/plugins` volume](#deploying-plugins-from-attached-volume). If you add plugins while the container is running, you'll need to restart it to pick those up.\n\n## Running a Paper server\n\nEnable Paper server mode by adding a `-e TYPE=PAPER` to your command-line.\n\nBy default the container will run the latest build of [Paper server](https://papermc.io/downloads)\nbut you can also choose to run a specific build with `-e PAPERBUILD=205`.\n\n    docker run -d -v /path/on/host:/data \\\n        -e TYPE=PAPER \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\nIf you are hosting your own copy of Paper you can override the download URL with:\n\n- -e PAPER_DOWNLOAD_URL=\u003curl\u003e\n\nAn example compose file is provided at\n[examples/docker-compose-paper.yml](examples/docker-compose-paper.yml).\n\nIf 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](#deploying-plugins-from-attached-volume). If you add plugins while the container is running, you'll need to restart it to pick those up.\n\n## Running a Tuinity server\n\nA [Tuinity](https://github.com/Spottedleaf/Tuinity) server, which is a fork of Paper aimed at improving server performance at high playercounts.\n\n    -e TYPE=TUINITY\n\n\u003e **NOTE** only `VERSION=LATEST` is supported\n\n## Running a Magma server\n\nA [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with\n\n    -e TYPE=MAGMA\n\n\u003e **NOTE** there are limited base versions supported, so you will also need to  set `VERSION`, such as \"1.12.2\"\n\n\n## Running a Mohist server\n\nA [Mohist](https://github.com/Mohist-Community/Mohist) server can be used with\n\n    -e TYPE=MOHIST\n\n\u003e **NOTE** there are limited base versions supported, so you will also need to  set `VERSION`, such as \"1.12.2\"\n\n\n## Running a Catserver type server\n\nA [Catserver](http://catserver.moe/) type server can be used with\n\n    -e TYPE=CATSERVER\n\n\u003e **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored\n\n## Running a server with a Feed the Beast modpack\n\n\u003e **NOTE** requires `itzg/minecraft-server:multiarch` image\n\n[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.\n\n### Environment Variables:\n- `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 using the \"ID\" displayed next to the name\n- `FTB_MODPACK_VERSION_ID`: optional, the numerical Id of the version to install. If not specified, the latest version will be installed. The \"Version ID\" can be obtained by drilling into the Versions tab and clicking a specific version.\n\n### Upgrading\n\nIf 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.\n\n### Example\n\nThe following example runs the latest version of [FTB Presents Direwolf20 1.12](https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/):\n\n```\ndocker run -d --name mc-ftb -e EULA=TRUE \\\n  -e TYPE=FTBA -e FTB_MODPACK_ID=31 \\\n  -p 25565:25565 \\\n  itzg/minecraft-server:multiarch\n```\n\n\u003e Normally you will also add `-v` volume for `/data` since the mods and config are installed there along with world data.\n\n## Running a server with a CurseForge modpack\n\nEnable this server mode by adding `-e TYPE=CURSEFORGE` to your command-line,\nbut note the following additional steps needed...\n\nYou need to specify a modpack to run, using the `CF_SERVER_MOD` environment\nvariable. A CurseForge server modpack is available together with its respective\nclient modpack at \u003chttps://www.curseforge.com/minecraft/modpacks\u003e .\n\nNow you can add a `-e CF_SERVER_MOD=name_of_modpack.zip` to your command-line.\n\n    docker run -d -v /path/on/host:/data -e TYPE=CURSEFORGE \\\n        -e CF_SERVER_MOD=SkyFactory_4_Server_4.1.0.zip \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\nIf you want to keep the pre-download modpacks separate from your data directory,\nthen you can attach another volume at a path of your choosing and reference that.\nThe following example uses `/modpacks` as the container path as the pre-download area:\n\n    docker run -d -v /path/on/host:/data -v /path/to/modpacks:/modpacks \\\n        -e TYPE=CURSEFORGE \\\n        -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\n#### Buggy start scripts\n\nSome 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`.\n\n### Fixing \"unable to launch forgemodloader\"\n\nIf 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):\n\n    unable to launch forgemodloader\n\nthen you apply a workaround by adding this to the run invocation:\n\n    -e FTB_LEGACYJAVAFIXER=true\n\n## Running a SpongeVanilla server\n\nEnable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your command-line.\nBy default the container will run the latest `STABLE` version.\nIf you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line.\n\n    docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \\\n        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n\nYou can also choose to use the `EXPERIMENTAL` branch.\nJust change it with `SPONGEBRANCH`, such as:\n\n    $ docker run -d -v /path/on/host:/data ... \\\n        -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ...\n\n## Running a Fabric Server\n\nEnable [Fabric server](http://fabricmc.net/use/) mode by adding a `-e TYPE=FABRIC` to your command-line. By default, the container will run the latest version, but you can also choose to run a specific version with `VERSION`.\n\n```\ndocker run -d -v /path/on/host:/data \\\n    -e TYPE=FABRIC \\\n    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n```\n\nA specific installer version can be requested using `FABRIC_INSTALLER_VERSION`. \n\nTo use a pre-downloaded Fabric installer, place it in a directory attached into the container, such as the `/data` volume and specify the name of the installer file with `FABRIC_INSTALLER`, such as:\n\n```\ndocker run -d -v /path/on/host:/data ... \\\n    -e FABRIC_INSTALLER=fabric-installer-0.5.0.32.jar ...\n```\n\nTo download a Fabric installer from a custom location, such as your own file repository, specify the URL with `FABRIC_INSTALLER_URL`, such as:\n\n```\ndocker run -d -v /path/on/host:/data ... \\\n    -e FABRIC_INSTALLER_URL=http://HOST/fabric-installer-0.5.0.32.jar ...\n```\n\nIn order to add mods, you have two options:\n\n### Using the /data volume\n\nThis is the easiest way if you are using a persistent `/data` mount.\n\nTo do this, you will need to attach the container's `/data` directory\n(see \"Attaching data directory to host filesystem”).\nThen, you can add mods to the `/path/on/host/mods` folder you chose. From the example above,\nthe `/path/on/host` folder contents look like:\n\n```\n/path/on/host\n├── mods\n│   └── ... INSTALL MODS HERE ...\n├── config\n│   └── ... CONFIGURE MODS HERE ...\n├── ops.json\n├── server.properties\n├── whitelist.json\n└── ...\n```\n\nIf you add mods while the container is running, you'll need to restart it to pick those\nup:\n\n    docker stop mc\n    docker start mc\n\n### Using separate mounts\n\nThis is the easiest way if you are using an ephemeral `/data` filesystem,\nor downloading a world with the `WORLD` option.\n\nThere are two additional volumes that can be mounted; `/mods` and `/config`.\nAny files in either of these filesystems will be copied over to the main\n`/data` filesystem before starting Minecraft.\n\nThis works well if you want to have a common set of modules in a separate\nlocation, but still have multiple worlds with different server requirements\nin either persistent volumes or a downloadable archive.\n\n## Deploying plugins from attached volume\n\nThere is one additional volume that can be mounted; `/plugins`. Any files in this filesystem will be copied over to the main `/data/plugins` filesystem before starting Minecraft. Set `PLUGINS_SYNC_UPDATE=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`.\n\nThis works well if you want to have a common set of plugins in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.\n\n## Running with a custom server JAR\n\nIf you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server\nJAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.\n\nIf it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As\nsuch, if you need to upgrade or re-download the JAR, then you will need to stop the container,\nremove the file from the container's `/data` directory, and start again.\n\n## Force re-download of the server file\n\nFor VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set\n`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for\nthe particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.\n\nFor example, with PaperSpigot, it would look something like this:\n\n```\ndocker run -d -v /path/on/host:/data \\\n    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \\\n    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server\n```\n\n## Using Docker Compose\n\nRather than type the server options below, the port mappings above, etc\nevery time you want to create new Minecraft server, you can now use\n[Docker Compose](https://docs.docker.com/compose/). Start with a\n`docker-compose.yml` file like the following:\n\n```\nminecraft-server:\n  ports:\n    - \"25565:25565\"\n\n  environment:\n    EULA: \"TRUE\"\n\n  image: itzg/minecraft-server\n\n  container_name: mc\n\n  tty: true\n  stdin_open: true\n  restart: always\n```\n\nand in the same directory as that file run\n\n    docker-compose up -d\n\nNow, go play...or adjust the `environment` section to configure\nthis server instance.\n\n## Server configuration\n\nBy default the server configuration will be created and set based on the following\nenvironment variables, but only the first time the server is started. If the\n`server.properties` file already exists, the values in them will not be changed.\n\nIf you would like to override the server configuration each time the container\nstarts up, you can set the OVERRIDE_SERVER_PROPERTIES environment variable like:\n\n    docker run -d -e OVERRIDE_SERVER_PROPERTIES=true ...\n\nThis will reset any manual configuration of the `server.properties` file, so if\nyou want to make any persistent configuration changes you will need to make sure\nyou have properly set the proper environment variables in your docker run command (described below).\n\n### Server name\n\nThe server name (e.g. for bungeecord) can be set like:\n\n    docker run -d -e SERVER_NAME=MyServer ...\n\n### Server port\n\n\u003e **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.\n\nIf you must, the server port can be set like:\n\n    docker run -d -e SERVER_PORT=25566 ...\n\n**however**, be sure to change your port mapping accordingly and be prepared for some features to break.\n\n### Difficulty\n\nThe difficulty level (default: `easy`) can be set like:\n\n    docker run -d -e DIFFICULTY=hard ...\n\nValid values are: `peaceful`, `easy`, `normal`, and `hard`, and an\nerror message will be output in the logs if it's not one of these\nvalues.\n\n### Whitelist Players\n\nTo whitelist players for your Minecraft server, pass the Minecraft usernames separated by commas via the `WHITELIST` environment variable, such as\n\n    docker run -d -e WHITELIST=user1,user2 ...\n\nIf the `WHITELIST` environment variable is not used, any user can join your Minecraft server if it's publicly accessible.\n\n### Op/Administrator Players\n\nTo add more \"op\" (aka adminstrator) users to your Minecraft server, pass the Minecraft usernames separated by commas via the `OPS` environment variable, such as\n\n    docker run -d -e OPS=user1,user2 ...\n\n### Server icon\n\nA server icon can be configured using the `ICON` variable. The image will be automatically\ndownloaded, scaled, and converted from any other image format:\n\n    docker run -d -e ICON=http://..../some/image.png ...\n\n### Rcon\n\nTo use rcon use the `ENABLE_RCON` and `RCON_PASSORD` variables.\nBy default rcon port will be `25575` but can easily be changed with the `RCON_PORT` variable.\n\n    docker run -d -e ENABLE_RCON=true -e RCON_PASSWORD=testing\n\n### Query\n\nEnabling this will enable the gamespy query protocol.\nBy default the query port will be `25565` (UDP) but can easily be changed with the `QUERY_PORT` variable.\n\n    docker run -d -e ENABLE_QUERY=true\n\n### Max players\n\nBy default max players is 20, you can increase this with the `MAX_PLAYERS` variable.\n\n    docker run -d -e MAX_PLAYERS=50\n\n### Max world size\n\nThis sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain.\n\n    docker run -d -e MAX_WORLD_SIZE=10000\n\n### Allow Nether\n\nAllows players to travel to the Nether.\n\n    docker run -d -e ALLOW_NETHER=true\n\n### Announce Player Achievements\n\nAllows server to announce when a player gets an achievement.\n\n    docker run -d -e ANNOUNCE_PLAYER_ACHIEVEMENTS=true\n\n### Enable Command Block\n\nEnables command blocks\n\n     docker run -d -e ENABLE_COMMAND_BLOCK=true\n\n### Force Gamemode\n\nForce players to join in the default game mode.\n\n- false - Players will join in the gamemode they left in.\n- true - Players will always join in the default gamemode.\n\n  `docker run -d -e FORCE_GAMEMODE=false`\n\n### Generate Structures\n\nDefines whether structures (such as villages) will be generated.\n\n- false - Structures will not be generated in new chunks.\n- true - Structures will be generated in new chunks.\n\n  `docker run -d -e GENERATE_STRUCTURES=true`\n\n### Hardcore\n\nIf set to true, players will be set to spectator mode if they die.\n\n    docker run -d -e HARDCORE=false\n\n### Snooper\n\nIf set to false, the server will not send data to snoop.minecraft.net server.\n\n    docker run -d -e SNOOPER_ENABLED=false\n\n### Max Build Height\n\nThe maximum height in which building is allowed.\nTerrain may still naturally generate above a low height limit.\n\n    docker run -d -e MAX_BUILD_HEIGHT=256\n\n### Max Tick Time\n\nThe 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).\nSetting this to -1 will disable watchdog entirely\n\n    docker run -d -e MAX_TICK_TIME=60000\n\n### Spawn Animals\n\nDetermines if animals will be able to spawn.\n\n    docker run -d -e SPAWN_ANIMALS=true\n\n### Spawn Monsters\n\nDetermines if monsters will be spawned.\n\n    docker run -d -e SPAWN_MONSTERS=true\n\n### Spawn NPCs\n\nDetermines if villagers will be spawned.\n\n    docker run -d -e SPAWN_NPCS=true\n\n### Set spawn protection\n\nSets the area that non-ops can not edit (0 to disable)\n\n    docker run -d -e SPAWN_PROTECTION=0\n\n### View Distance\n\nSets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter).\nIt determines the server-side viewing distance.\n\n    docker run -d -e VIEW_DISTANCE=10\n\n### Level Seed\n\nIf you want to create the Minecraft level with a specific seed, use `SEED`, such as\n\n    docker run -d -e SEED=1785852800490497919 ...\n\n### Game Mode\n\nBy default, Minecraft servers are configured to run in Survival mode. You can\nchange the mode using `MODE` where you can either provide the [standard\nnumerical values](http://minecraft.gamepedia.com/Game_mode#Game_modes) or the\nshortcut values:\n\n- creative\n- survival\n- adventure\n- spectator (only for Minecraft 1.8 or later)\n\nFor example:\n\n    docker run -d -e MODE=creative ...\n\n### Message of the Day\n\nThe message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as\n\n    docker run -d -e 'MOTD=My Server' ...\n\nIf you leave it off, a default is computed from the server type and version, such as\n\n    A Paper Minecraft Server powered by Docker\n\nwhen `TYPE` is `PAPER`. That way you can easily differentiate between several servers you may have started.\n\n_The example shows how to specify a server message of the day that contains spaces by putting quotes\naround the whole thing._\n\n### PVP Mode\n\nBy default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP`\nenvironment variable set to `false`, such as\n\n    docker run -d -e PVP=false ...\n\n### Level Type and Generator Settings\n\nBy default, a standard world is generated with hills, valleys, water, etc. A different level type can\nbe configured by setting `LEVEL_TYPE` to an expected type, such as\n\n- DEFAULT\n- FLAT\n- LARGEBIOMES\n- AMPLIFIED\n- CUSTOMIZED\n- BUFFET\n\nDescriptions are available at the [gamepedia](http://minecraft.gamepedia.com/Server.properties).\n\nWhen using a level type of `FLAT`, `CUSTOMIZED`, and `BUFFET`, you can further configure the world generator\nby passing [custom generator settings](http://minecraft.gamepedia.com/Superflat).\n**Since generator settings usually have ;'s in them, surround the -e value with a single quote, like below.**\n\nFor example (just the `-e` bits):\n\n    -e LEVEL_TYPE=flat -e 'GENERATOR_SETTINGS=3;minecraft:bedrock,3*minecraft:stone,52*minecraft:sandstone;2;'\n\n### Custom Server Resource Pack\n\nYou 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:\n\n    docker run -d -e 'RESOURCE_PACK=http\\://link.com/to/pack.zip?\\=1' -e 'RESOURCE_PACK_SHA1=d5db29cd03a2ed055086cef9c31c252b4587d6d0'\n\n**NOTE:** `:` and `=` must be escaped using `\\`. The checksum plain-text hexadecimal.\n\n### World Save Name\n\nYou can either switch between world saves or run multiple containers with different saves by using the `LEVEL` option,\nwhere the default is \"world\":\n\n    docker run -d -e LEVEL=bonus ...\n\n**NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each\n`LEVEL` in use or don't use `-v` and the container's filesystem will keep things encapsulated.\n\n### Downloadable world\n\nInstead of mounting the `/data` volume, you can instead specify the URL of a ZIP 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.\n\n    docker run -d -e WORLD=http://www.example.com/worlds/MySave.zip ...\n\n**NOTE:** This URL must be accessible from inside the container. Therefore,\nyou should use an IP address or a globally resolvable FQDN, or else the\nname of a linked container.\n\n**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.\n\n### Cloning world from a container path\n\nThe `WORLD` option can also be used to reference a directory or zip file that will be used as a source to clone or unzip the world directory.\n\nFor example, the following would initially clone the world's content\nfrom `/worlds/basic`. Also notice in the example that you can use a\nread-only volume attachment to ensure the clone source remains pristine.\n\n```\ndocker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic\n```\n\n### Overwrite world on start\nThe 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.\n\n### Downloadable mod/plugin pack for Forge, Bukkit, and Spigot Servers\n\nLike the `WORLD` option above, you can specify the URL of a \"mod pack\"\nto download and install into `mods` for Forge or `plugins` for Bukkit/Spigot.\nTo use this option pass the environment variable `MODPACK`, such as\n\n    docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...\n\n**NOTE:** The referenced URL must be a zip file with one or more jar files at the\ntop level of the zip archive. Make sure the jars are compatible with the\nparticular `TYPE` of server you are running.\n\nYou may also download individual mods using the `MODS` environment variable and supplying the URL\nto the jar files. Multiple mods/plugins should be comma separated.\n\n    docker run -d -e MODS=https://www.example.com/mods/mod1.jar,https://www.example.com/mods/mod2.jar ...\n\n### Remove old mods/plugins\n\nWhen the option above is specified (`MODPACK`) you can also instruct script to\ndelete old mods/plugins prior to installing new ones. This behaviour is desirable\nin case you want to upgrade mods/plugins from downloaded zip file.\nTo use this option pass the environment variable `REMOVE_OLD_MODS=\"TRUE\"`, such as\n\n    docker run -d -e REMOVE_OLD_MODS=\"TRUE\" -e MODPACK=http://www.example.com/mods/modpack.zip ...\n\n**WARNING:** All content of the `mods` or `plugins` directory will be deleted\nbefore unpacking new content from the MODPACK or MODS.\n\n### Online mode\n\nBy 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\n\n    docker run -d -e ONLINE_MODE=FALSE ...\n\n### Allow flight\n\nAllows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.\n\n    -e ALLOW_FLIGHT=TRUE|FALSE\n\n### Other server property mappings\n\n| Environment Variable              | Server Property                   |\n| --------------------------------- | --------------------------------- |\n| PLAYER_IDLE_TIMEOUT               | player-idle-timeout               |\n| BROADCAST_CONSOLE_TO_OPS          | broadcast-console-to-ops          |\n| BROADCAST_RCON_TO_OPS             | broadcast-rcon-to-ops             |\n| ENABLE_JMX                        | enable-jmx-monitoring             |\n| SYNC_CHUNK_WRITES                 | sync-chunk-writes                 |\n| ENABLE_STATUS                     | enable-status                     |\n| ENTITY_BROADCAST_RANGE_PERCENTAGE | entity-broadcast-range-percentage |\n| FUNCTION_PERMISSION_LEVEL         | function-permission-level         |\n| NETWORK_COMPRESSION_THRESHOLD     | network-compression-threshold     |\n| OP_PERMISSION_LEVEL               | op-permission-level               |\n| PREVENT_PROXY_CONNECTIONS         | prevent-proxy-connections         |\n| USE_NATIVE_TRANSPORT              | use-native-transport              |\n| ENFORCE_WHITELIST                 | enforce-whitelist                 |\n\n## Miscellaneous Options\n\n### Running as alternate user/group ID\n\nBy default, the container will switch to user ID 1000 and group ID 1000;\nhowever, you can override those values by setting `UID` and/or `GID` as environmental entries, during the `docker run` command.\n\n    -e UID=1234\n    -e GID=1234\n\nThe container will also skip user switching if the `--user`/`-u` argument\nis passed to `docker run`.\n\n### Memory Limit\n\nBy default, the image declares a Java initial and maximum memory limit of 1 GB. There are several\nways to adjust the memory settings:\n\n- `MEMORY`, \"1G\" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`)\n  memory settings of the JVM\n- `INIT_MEMORY`, independently sets the initial heap size\n- `MAX_MEMORY`, independently sets the max heap size\n\nThe values of all three are passed directly to the JVM and support format/units as\n`\u003csize\u003e[g|G|m|M|k|K]`. For example:\n\n    -e MEMORY=2G\n\n### JVM Options\n\nGeneral JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`\nenvironment variable. Options like `-X` that need to proceed general JVM options can be passed\nvia a `JVM_XX_OPTS` environment variable.\n\nFor some cases, if e.g. after removing mods, it could be necessary to startup minecraft with an additional `-D` parameter like `-Dfml.queryResult=confirm`. To address this you can use the environment variable `JVM_DD_OPTS`, which builds the params from a given list of values separated by space, but without the `-D` prefix. To make things running under systems (e.g. Plesk), which doesn't allow `=` inside values, a `:` (colon) could be used instead. The upper example would look like this:\n`JVM_DD_OPTS=fml.queryResult:confirm`, and will be converted to `-Dfml.queryResult=confirm`.\n\n### Enable Remote JMX for Profiling\n\nTo enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true` and add a port forwarding of TCP port 7091, such as:\n\n    -e ENABLE_JMX=true -p 7091:7091\n\n### Enable Aikar's Flags\n\n[Aikar has does some research](https://mcflags.emc.gs/) 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\n\n    -e USE_AIKAR_FLAGS=true\n\nWhen `MEMORY` is greater than or equal to 12G, then the Aikar flags will be adjusted according to the article.\n\nLarge page support can also be enabled by adding\n\n    -e USE_LARGE_PAGES=true\n\n### HTTP Proxy\n\nYou may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL via the `PROXY`\nenvironment variable. In [the example compose file](examples/docker-compose-proxied.yml) it references\na companion squid proxy by setting the equivalent of\n\n    -e PROXY=proxy:3128\n\n### Using \"noconsole\" option\n\nSome older versions (pre-1.14) of Spigot required `--noconsole` to be passed when detaching stdin, which can be done by setting `-e CONSOLE=FALSE`.\n\n### Explicitly disable GUI\n\nSome older servers get confused and think that the GUI interface is enabled. You can explicitly\ndisable that by passing `-e GUI=FALSE`.\n\n### Stop Duration\n\nWhen 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 defaul it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.\n\n## Running on RaspberryPi\n\nTo run this image on a RaspberryPi 3 B+, 4, or newer, use the image tag\n\n    itzg/minecraft-server:multiarch\n\n\u003e NOTE: you may need to lower the memory allocation, such as `-e MEMORY=750m`\n","projects_url":"https://awesome.ecosyste.ms/api/v1/lists/awesome-release%2Fdocker-minecraft-server/projects"}