Skip to content

Latest commit

 

History

History
180 lines (143 loc) · 6.74 KB

README.md

File metadata and controls

180 lines (143 loc) · 6.74 KB
Raw

docker-mcmyadmin

GitHub Workflow Status GitHub Release Date GitHub last commit

McMyAdmin Panel docker file to administrate and run all variants of a Java Minecraft Server.

Note: As the below is overseen often, the default user/password for the McMyAdmin Login is admin / pass123

buy-me-a-coffee

If I've helped you and you like some of my work, feel free to buy me a coffee ☕ (or more likely a beer 🍺)

Buy Me a Coffee at ko-fi.com

Description

Goal of this docker image is to create an easy to use docker file providing the up to date McMyAdmin Panel which can run all kinds of Java Minecraft versions. Most images on Docker Hub do not save the world when stopping the container, which has been added to this image. The actual persistent data e.g. worlds, configuration, etc. is mounted to a volume so it can be configured easily. Also this docker image tails the latest McMyAdmin log file to provide logging information e.g. Portainer or on the command line.

Details

  • Utilizing Debian 11 Bullseye slim version
  • OpenJDK-18 is used as it is required for some Minecraft plugins
  • McMyAdmin Minecraft web based admin panel
  • When the container stops firstly the world is saved and the server is properly shut down.
  • The McMyAdmin Admin panel runs under minecraft user on port tcp/8080
  • The actual Minecraft server runs on default port tcp/25565
  • Maps a volume so you are free to make changes to configuration of McMyAdmin and Minecraft
  • Includes GIT so the Spigot server jar can be build by McMyAdmin
  • Java.Memory defaults to 2GB RAM / recommended are at least 2GB RAM within a docker container
  • If you like to run the Dynmap just expose port tcp/8123 as well

Run

Basic run command to get things up and running

docker run -d \
  --name mcmyadmin \
  -p 8080:8080 \
  -p 25565:25565 \
  --stop-timeout 30 \
  --restart unless-stopped \
  tekgator/docker-mcmyadmin:latest

Map to local storage using an existing user on the host machine (get UID/GID via ID command)

-v /home/xxx/McMyAdmin:/data
-e PUID=xxx
-e PGID=xxx

Option to accept the Minecraft Server EULA automatically

-e EULA=1

Start and Re-start container automatically

--restart unless-stopped

Allow enough time when the container is stopped to shutdown Minecraft and McMyAdmin gracefully

--stop-timeout 30

If you like to expose other ports for some plugins e.g. Dynmap

-p 8123:8123 \

Personal recommandation on how to use it

  • Create a user on the host system e.g. minecraft via useradd minecraft
  • Login with that user
  • Create a directory for the game data in the home directory of this user via mkdir ~/mcmyadmin
  • Obtain the UID and GID of that user via id minecraft e.g. UID 1000 / GID 100
  • Login to your admin user for creating the docker container

Use with docker run:

docker run -d \
  --name mcmyadmin \
  -p 8080:8080 \
  -p 25565:25565 \
  -v /home/minecraft/mcmyadmin:/data \
  -e PUID=1000 \
  -e PGID=100 \
  -e EULA=1 \
  --restart unless-stopped  \
  --stop-timeout 30 \
  tekgator/docker-mcmyadmin:latest

Use with docker-compose:

A sample docker-compose file can be found within the repository.

  mcmyadmin:
    image: tekgator/docker-mcmyadmin:latest
    container_name: mcmyadmin
    environment:
      PUID: 1000
      PGID: 100
      EULA: 1
    volumes:
      - /home/minecraft/mcmyadmin:/data
    ports:
      - 8080:8080
      - 25565:25565
    stop_grace_period: 30s
    restart: unless-stopped

Now you have access to the Minecraft game data via the minecraft user on the host system by accessing cd ~/mcmyadmin

HAVE FUN!

Next steps

  1. Open McMyAdmin in your browser e.g. via http://localhost:8080
  2. Login with
    • User: admin
    • Password: pass123
  3. Change the password!!!
  4. Select the Minecraft version to run in the settings e.g. Vanilla, Spigot, etc. and press the install button (note Spigot build will take a while)
  5. Configure your Minecraft server in the server settings
  6. Click Start Server from Status tab (this will stop/restart a couple times, be patient)

Optional but recommended steps

  1. Stop the container
  2. Open the file McMyAdmin.conf in your locale storage in an editor
  3. Search for the line Java.Memory
  4. Change to your needs, recommended is at least 2GB
  5. Start the container

Adding Plugins or changing configuration of McMyAdmin / Minecraft

Within the mounted volume you can find:

  • The McMyAdmin.conf file to configure the McMyAdmin Panel like Java RAM usage, etc.
  • The Minecraft directory where you can find the server.properties, logs, etc.
  • The plugin directory to add mods and change the configuration of mods

Additional info

  • Shell access whilst the container is running: docker exec -it mcmyadmin /bin/bash
  • To monitor the logs of the container in realtime: docker logs -f mcmyadmin