docker-minecraft-server README

The project's README from github.com/itzg/docker-minecraft-server. As one markdown file: README.md.

Docker Pulls Docker Stars GitHub Issues Discord Build and Publish Documentation Status

Read the docs

There you will find things like

There are also many examples located in the examples directory of this repo.

This image only supports Java edition natively; however, if looking for a server that is compatible with Bedrock edition, then use itzg/minecraft-bedrock-server or refer to this section to add Bedrock compatibility to a Java edition server.

Sponsors

SpawnBox logo

SpawnBox - Powered by itzg/minecraft-server, it's a Windows desktop app for parents, teens, and friend groups who want a Minecraft server on their own PC without learning Docker, WSL2, or networking.


Server.pro logo

Server.pro - A game server hosting platform offering one-click Minecraft server deployment powered by itzg/minecraft-server, with global locations and an easy-to-use control panel.


Seedloaf logo

Seedloaf - Built from scratch (by two nerds) on top of itzg/minecraft-server. Seedloaf offers free, and premium Minecraft servers where you have full control!


and more...

docker-minecraft-server (itzg/docker-minecraft-server)

Searching Database…

What is this?A Docker image that runs a Minecraft Java Edition server — at startup it automatically installs and upgrades the server version, modloaders, and modpacks for you.
Is this an app I install, or a Docker image I run on my own machine?It's a Docker image, not a standalone app: you run it as a container and configure the server through container environment variables instead of editing files.
How do I get a server running?Follow the README's quick start with Docker Compose; the repo's examples directory also has many ready-made setups you can copy for common cases.
Do I need to install Java or the Minecraft server software first?No — the image downloads the server itself at startup; the only real prerequisite is Docker, with Docker Compose recommended for the quick start.
Can friends playing Bedrock Edition join my server?Not with this image alone — it supports Java Edition only natively; the README points to the itzg/minecraft-bedrock-server image or a documented section for adding Bedrock compatibility.
Where can I host it — does my OS matter?Anywhere Docker runs: a Linux box or VPS, or Windows/macOS with Docker — the whole Minecraft server lives inside the container.
Can I run modded servers and modpacks with it?Yes — it manages mods and plugins with automated downloads and cleanup, and supports various modpack providers and platforms.
Can I choose which Minecraft version and server type it runs?Yes — it can run different Minecraft versions and various Java Edition server types, installing or upgrading the requested one automatically at startup.
What if I'd rather not self-host?The README mentions hosted providers like Seedloaf with free and premium plans, but the project itself is a self-hosted Docker image — running it is on you.
What are similar projects?Paper, Pumpkin, kaniko, dockerfiles, slim, portainer, distroless, dockhand
Creator
itzg
Size
5.6 MB
Stars
14.4K
Age
12y
Commits · 90 Days