https://github.com/sksat/papermc-docker

Docker container for PaperMC
https://github.com/sksat/papermc-docker

Last synced: 7 days ago
JSON representation

Docker container for PaperMC

• Host: GitHub
• URL: https://github.com/sksat/papermc-docker
• Owner: sksat
• License: mit
• Created: 2021-06-30T15:24:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T00:20:49.000Z (6 months ago)
• Last Synced: 2024-05-01T16:21:49.139Z (6 months ago)
• Language: Shell
• Size: 336 KB
• Stars: 15
• Watchers: 1
• Forks: 3
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# papermc-docker

[![Build Container Image](https://github.com/sksat/papermc-docker/actions/workflows/build-image.yml/badge.svg)](https://github.com/sksat/papermc-docker/actions/workflows/build-image.yml)

[![image version](https://img.shields.io/docker/v/sksat/papermc-docker?sort=semver)](https://hub.docker.com/r/sksat/papermc-docker)

[![image pulls](https://img.shields.io/docker/pulls/sksat/papermc-docker)](https://hub.docker.com/r/sksat/papermc-docker)

Docker container for [PaperMC](https://papermc.io/)

## Image

|Registry|Image|

|-|-|

|[DockerHub](https://hub.docker.com/r/sksat/papermc-docker)|`sksat/papermc-docker`|

|[GitHub Container Registry](https://github.com/sksat/papermc-docker/pkgs/container/papermc-docker)|`ghcr.io/sksat/papermc-docker`|

|tag|Image Size|

|-|-|

|`1.18`|![1.18](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18)|

|`1.18-R0.1-SNAPSHOT`|![1.18-R0.1-SNAPSHOT](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-R0.1-SNAPSHOT)|

|`1.18-openjdk`|![1.18-openjdk](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-openjdk)|

|`1.18-openjdk-17-slim`|![1.18-openjdk-17-slim](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-openjdk-17-slim)|

|`1.18-openjdk-17-slim-buster`|![1.18-openjdk-17-slim-buster](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-openjdk-17-slim-buster)|

|`1.18-openjdk-17-oraclelinux8`|![1.18-openjdk-17-oraclelinux8](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-openjdk-17-oraclelinux8)|

|`1.18-temurin-17.0.1_12-jdk`|![1.18-temurin-17.0.1_12-jdk](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-temurin-17.0.1_12-jdk)|

|`1.18-temurin-17.0.1_12-jdk-focal`|![1.18-temurin-17.0.1_12-jdk-focal](https://img.shields.io/docker/image-size/sksat/papermc-docker/1.18-temurin-17.0.1_12-jdk-focal)|

### Tags

tag structure: `---`

Some fields have default value.

If the tag contains a default value, there are other versions of tags that do not include that field.

Example: `main-1.18-R0.1-SNAPSHOT-d0a2193-alpine-jre` -> `1.18-alpine`

- tag field

|field|detail|default value|example|

|-|-|-|-|

|branch|branch name|`main`|`renovate/openjdk-17-slim`|

|Minecraft version|Minecraft(PaperMC) version|N/A|`1.18`,`1.18-R0.1-SNAPSHOT`,`1.18-R0.1-SNAPSHOT-0cd411e`|

|JDK|OpenJDK or Eclipse temurin|`openjdk`|`temurin`,`openjdk`|

|base-img|Base Image|It depends on JDK. `openjdk`->`17-slim`|

## Deploy

```sh

$ git clone https://github.com/sksat/papermc-docker

$ cd papermc-docker

$ mkdir data

$ echo "eula=true" > data/eula.txt

$ docker-compose up -d

```

## Disclaimer

This project use [paperclip system](https://paper.readthedocs.io/en/latest/about/structure.html#id2).

So this container image does not contain vanilla Minecraft jar file.

The vanilla Minecraft jar file will be downloaded and patched at the first time the container is started.