Skip to content

Latest commit

 

History

History
328 lines (180 loc) · 8.83 KB

README.md

File metadata and controls

328 lines (180 loc) · 8.83 KB

Minecraft server SPIGOT

Docker Automated build Docker Stars Docker Pulls Docker Build Status

This image replace the old image: ashdev/docker-spigot

Minecraft 1.15 Nether Update

This docker image is ready to use the latest version of Minecraft (1.15 Nether Update)

Available tags

All available tags are always listed in Docker Hub:

  • 1.15, latest: Latest server for Minecraft 1.15.
  • 1.15-alpine, alpine: Latest server using Alpine for Minecraft 1.15.

The plugins are using the latest version. In case of issue, disable them.

To use the version 1.15 of docker run

docker run -d -e REV=1.15 -p 25565:25565 ashdev/minecraft-spigot:latest

Description

This docker image provides a Minecraft Server with Spigot that will automatically download the latest stable version at startup.

To simply use the latest stable version, run

docker run -d -p 25565:25565 ashdev/minecraft-spigot:latest

where the standard server port, 25565, will be exposed on your host machine.

If you want to serve up multiple Minecraft servers or just use an alternate port, change the host-side port mapping such as

docker run -p 25566:25565 ...

will serve your Minecraft server on your host's port 25566 since the -p syntax is host-port:container-port.

Speaking of multiple servers, it's handy to give your containers explicit names using --name, such as

docker run -d -p 25565:25565 --name mc ashdev/minecraft-spigot:latest

With that you can easily view the logs, stop, or re-start the container:

docker logs -f mc
    ( Ctrl-C to exit logs action )

docker stop mc

docker start mc

Interacting with the server

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 ashdev/minecraft-spigot:latest

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.

Run commands in the Minecraft servers

You can send commands in the server by calling

docker exec mc /spigot_cmd.sh <command>

example:

docker exec mc /spigot_cmd.sh op AshDevFr

High CPU on spigot server

You can disable the console to reduce the CPU usage but you will loose the ability to send commands to the server

docker run -d -e NOCONSOLE=true ...

EULA Support

Mojang now requires accepting the Minecraft EULA. To accept add

-e EULA=TRUE

such as

docker run -d -it -e EULA=TRUE -p 25565:25565 ashdev/minecraft-spigot:latest

Attaching data directory to host filesystem

In order to readily access the Minecraft data, use the -v argument to map a directory on your host machine to the container's /minecraft directory, such as:

docker run -d -v /path/on/host:/minecraft ...

When attached in this way you can stop the server, edit the configuration under your attached /path/on/host and start the server again with docker start CONTAINERID to pick up the new configuration.

Running with Plugins

In order to add mods, you will need to attach the container's /minecraft directory (see "Attaching data directory to host filesystem”). Then, you can add mods to the /path/on/host/mods folder you chose. From the example above, the /path/on/host folder contents look like:

/path/on/host
├── plugins
│   └── ... INSTALL PLUGINS HERE ...
├── ops.json
├── server.properties
├── whitelist.json
└── ...

If you add mods while the container is running, you'll need to restart it to pick those up:

docker stop $ID
docker start $ID

Server configuration

Op/Administrator Players

To add more "op" (aka adminstrator) users to your Minecraft server, pass the Minecraft usernames separated by commas via the OPS environment variable, such as

docker run -d -e OPS=user1,user2 ...

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 ...

Level Seed

If you want to create the Minecraft level with a specific seed, use SEED, such as

docker run -d -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 or the shortcut values:

  • creative
  • survival

For example:

docker run -d -e MODE=creative ...

Message of the Day

The message of the day, shown below each server entry in the UI, can be changed with the MOTD environment variable, such as

docker run -d -e 'MOTD=My Server' ...

If you leave it off, the last used or default message will be used. The example shows how to specify a server message of the day that contains spaces by putting quotes around the whole thing.

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 ...

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.

View Distance

docker run -d -e VDIST=10 ...

OP Permission Level

docker run -d -e OPPERM=4 ...

Allow Nether

docker run -d -e NETHER=true ...

Allow Flight

docker run -d -e FLY=false ...

Max Build Height

docker run -d -e MAXBHEIGHT=256 ...

Spawn NPCs

docker run -d -e NPCS=true ...

White List

docker run -d -e WLIST=false ...

Spawn Animals

docker run -d -e ANIMALS=true ...

Hardcore

docker run -d -e HC=false ...

Online Mode

docker run -d -e ONLINE=true ...

Ressource Pack

docker run -d -e RPACK='<url>' ...

Difficulty

docker run -d -e DIFFICULTY=3 ...

Enable Command Block

docker run -d -e CMDBLOCK=false ...

Max Players

docker run -d -e MAXPLAYERS=20 ...

Spawn Monsters

docker run -d -e MONSTERS=true ...

Generate Structures

docker run -d -e STRUCTURES=true ...

Spawn Protection

docker run -d -e SPAWNPROTECTION=16 ...

Max tick time

docker run -d -e MAX_TICK_TIME=60000 ...

Max World size

docker run -d -e MAX_WORLD_SIZE=29999984 ...

Resource pack sha1

docker run -d -e RPACK_SHA1= ...

Network compression threshold

docker run -d -e NETWORK_COMPRESSION_THRESHOLD=256 ...

JVM Configuration

Memory Limit

The Java memory limit can be adjusted using the JVM_OPTS environment variable, where the default is the setting shown in the example (max and min at 1024 MB):

docker run -e 'JVM_OPTS=-Xmx1024M -Xms1024M' ...

Plugins

DYNMAP=true ESSENTIALS=false ESSENTIALSPROTECT=false PERMISSIONSEX=false CLEARLAG=false

WorldBorder

docker run -d -e WORLDBORDER=true -p 8123:8123 ...

Dynmap

docker run -d -e DYNMAP=true -p 8123:8123 ...

Essentials

docker run -d -e ESSENTIALS=true ...

EssentialsProctect

docker run -d -e ESSENTIALS=true ESSENTIALSPROTECT=true ...

Creeper blockdamage options

docker run -d -e ESSENTIALS=true ESSENTIALSPROTECT=true ESSENTIALS_CREEPERBLOCKDMG=true ...

PermissionsEx

docker run -d -e PERMISSIONSEX=true ...

Clearlag

docker run -d -e CLEARLAG=true ...

Issues

If you have any problems with or questions about this image, please contact me by submitting a ticket through a GitHub issue

Thanks to nimmis & itzg