Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felixklauke/paper-docker
PaperSpigot Docker. Easy to use and clean docker image for running paper spigot servers in docker containers using OpenJDK. WIP
https://github.com/felixklauke/paper-docker
bukkit container containerized craftbukkit docker docker-container docker-image docker-images docker-paperspigot dockerized dockerized-paperspigot dockerized-spigot minecraft minecraft-docker paper paperspigot paperspigot-docker spigot spigot-container spigot-docker
Last synced: 3 months ago
JSON representation
PaperSpigot Docker. Easy to use and clean docker image for running paper spigot servers in docker containers using OpenJDK. WIP
- Host: GitHub
- URL: https://github.com/felixklauke/paper-docker
- Owner: felixklauke
- License: mit
- Created: 2018-09-23T06:31:05.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2022-06-21T06:06:59.000Z (over 2 years ago)
- Last Synced: 2024-09-28T12:02:35.269Z (4 months ago)
- Topics: bukkit, container, containerized, craftbukkit, docker, docker-container, docker-image, docker-images, docker-paperspigot, dockerized, dockerized-paperspigot, dockerized-spigot, minecraft, minecraft-docker, paper, paperspigot, paperspigot-docker, spigot, spigot-container, spigot-docker
- Language: Dockerfile
- Homepage: https://www.felix-klauke.com
- Size: 102 KB
- Stars: 55
- Watchers: 8
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# paperspigot-docker
Easy to use and clean Docker image for running Paper Spigot servers in Docker containers using OpenJDK.
You may also be interested in [waterfall-docker](https://github.com/FelixKlauke/waterfall-docker) and [velocity-docker](https://github.com/FelixKlauke/velocity-docker) if you want to build a whole server network.
# Getting started
The easiest way for a quick start would be:
```bash
docker run -it \
-p 25565:25565 \
-v ~/minecraft/config:/opt/minecraft/config \
-v ~/minecraft/worlds:/opt/minecraft/worlds \
-v ~/minecraft/plugins:/opt/minecraft/plugins \
-v ~/minecraft/data:/opt/minecraft/data \
-v ~/minecraft/logs:/opt/minecraft/logs \
felixklauke/paperspigot:1.16.5
```
# Tags and Versions
The Docker images are tagged for their Minecraft versions. These versions are currently available:
- `felixklauke/paperspigot:1.16.5`
- `felixklauke/paperspigot:1.16.4`
- `felixklauke/paperspigot:1.16.3`
- `felixklauke/paperspigot:1.16.2`
- `felixklauke/paperspigot:1.16.1`
- `felixklauke/paperspigot:1.15.2`
- `felixklauke/paperspigot:1.15.1`
- `felixklauke/paperspigot:1.15`
- `felixklauke/paperspigot:1.14.4`
- `felixklauke/paperspigot:1.14.3`
- `felixklauke/paperspigot:1.14.2`
- `felixklauke/paperspigot:1.14.1`
- `felixklauke/paperspigot:1.14`
- `felixklauke/paperspigot:1.13.2`
- `felixklauke/paperspigot:1.13.1`
- `felixklauke/paperspigot:1.13`
- `felixklauke/paperspigot:1.12.2`
- `felixklauke/paperspigot:1.12.1`
- `felixklauke/paperspigot:1.12`
- `felixklauke/paperspigot:1.11.2`
- `felixklauke/paperspigot:1.10.2`
- `felixklauke/paperspigot:1.9.4`
- `felixklauke/paperspigot:1.8.8`
The specific images are updated by hand. The 1.x-latest images will update at nightly builds and will always
use the latest build.
# Volumes
There are five volumes which are used for:
- Worlds
- Plugins
- Config files (paper.yml, bukkit.yml, spigot.yml, server.properties, commands.yml)
- Data (banned-ips.json, banned-players.json, help.yml, ops.json, permissions.yml, whitelist.json)
- Logs
You can find the mount locations in `docker-compose.yml`.
# docker-compose.yml
## Bind Mounts
This method is recommended if you have an already existing server which you wish to run inside a container [due to
the way bind mounts behave.](https://docs.docker.com/storage/bind-mounts/#mount-into-a-non-empty-directory-on-the-container)
You can add this simple entry to your docker-compose.yml when using bind mounts:
```yaml
version: '3.7'
services:
minecraft:
image: felixklauke/paperspigot:1.16.5
container_name: minecraft
stdin_open: true
tty: true
restart: always
networks:
- minecraft
ports:
- 25565:25565
volumes:
- ./config:/opt/minecraft/config
- ./worlds:/opt/minecraft/worlds
- ./plugins:/opt/minecraft/plugins
- ./data:/opt/minecraft/data
- ./logs:/opt/minecraft/logs
networks:
minecraft: {}
```
## Volumes
If you want to use explicit volumes, you can use this:
```yaml
version: '3.7'
services:
minecraft:
image: felixklauke/paperspigot:1.16.5
container_name: minecraft
stdin_open: true
tty: true
restart: always
networks:
- minecraft
ports:
- 25565:25565
volumes:
- minecraft-config:/opt/minecraft/config
- minecraft-worlds:/opt/minecraft/worlds
- minecraft-plugins:/opt/minecraft/plugins
- minecraft-data:/opt/minecraft/data
- minecraft-logs:/opt/minecraft/logs
volumes:
minecraft-config: {}
minecraft-worlds: {}
minecraft-plugins: {}
minecraft-data: {}
minecraft-logs: {}
networks:
minecraft: {}
```
# See Also
- [Docker CLI Reference: docker cp](https://docs.docker.com/engine/reference/commandline/cp/) - Copy files/folders between
a container and the local filesystem. Useful if you want to add new plugins, change settings, etc.
- [Docker CLI Reference: docker attach](https://docs.docker.com/engine/reference/commandline/attach/) - Attach to a
running container. Will attach to the server's console directly, allowing you to issue commands.