Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: 🐛 Bug Report
description: Report a problem with a setup, update, or Bedrock script.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug report! Please fill in the sections below so we can reproduce and fix the issue quickly.
- type: input
id: script
attributes:
label: Affected script
description: Which script did you run?
placeholder: e.g. setup_minecraft.sh, setup_minecraft_lxc.sh, setup_bedrock.sh, update.sh
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of the bug, including the full error output.
placeholder: Paste the terminal output / error here.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: How can we reproduce the problem?
placeholder: |
1. Run `./setup_minecraft.sh`
2. See error ...
validations:
required: true
- type: dropdown
id: environment
attributes:
label: Environment
description: Where did you run this?
options:
- Proxmox VM
- Proxmox LXC/CT
- Other (specify below)
validations:
required: true
- type: input
id: versions
attributes:
label: Versions
description: Proxmox VE, guest OS, and Java version.
placeholder: e.g. Proxmox VE 8.2, Debian 12, OpenJDK 21
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I re-downloaded the latest script from `main`.
required: true
- label: I searched existing issues and this is not a duplicate.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 📖 Documentation & Troubleshooting
url: https://github.com/TimInTech/minecraft-server-Proxmox#troubleshooting
about: Check the README troubleshooting section before opening an issue.
- name: 💬 Questions & Discussion
url: https://github.com/TimInTech/minecraft-server-Proxmox/issues
about: For general questions, please open a regular issue.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 💡 Feature Request
description: Suggest an improvement or a new capability.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: Problem / motivation
description: What are you trying to do, and what is missing or hard today?
placeholder: I'm always frustrated when ...
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe what you'd like to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Any workarounds or other approaches you thought about.
validations:
required: false
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues and this is not a duplicate.
required: true
35 changes: 35 additions & 0 deletions README.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@

---

## ✨ Warum dieses Repo?

- 🚀 **Installation mit einem Befehl** — ein einziges Skript richtet in Minuten einen produktionsreifen Minecraft-Server (Java **oder** Bedrock) auf Proxmox ein.
- 🧩 **VM *und* LXC/CT** — unterstützt beide Proxmox-Virtualisierungsmodelle, inkl. fertigem CT-Helfer für Bedrock.
- 🔄 **Selbst-aktualisierend** — `update.sh` zieht den neuesten **stabilen** PaperMC-Build über die neue **Fill-v3-API** mit SHA256- + Größenprüfung.
- 🔒 **Sicher voreingestellt** — verifizierte Downloads, zufällige CT-Passwörter, UFW-Firewall-Anleitung und Integritätsprüfungen (keine HTML-Fehlerseiten als `server.jar`).
- 🧠 **Automatisch dimensionierter JVM-Speicher** — skaliert zum Host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, gedeckelt bei 16 G) — kein manuelles Tuning nötig.
- 🛡️ **CI-geprüft** — jedes Shell-Skript wird bei jedem Push mit ShellCheck geprüft.
- 🇩🇪🇬🇧 **Zweisprachige Doku** — vollständige deutsche und englische Dokumentation, synchron gehalten.

---

## 📑 Inhaltsverzeichnis

- [Voraussetzungen](#-voraussetzungen)
- [Einführung](#einführung)
- [Schnellstart](#schnellstart)
- [Backups](#-backups)
- [Auto-Update](#-auto-update)
- [Konfiguration](#konfiguration)
- [Integrität & Firewall](#integrität--firewall)
- [Proxmox-CT-Helfer (Bedrock)](#proxmox-ct-helfer-bedrock)
- [PaperMC-API-Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3)
- [Admin/Befehle](#-adminbefehle)
- [Fehlerbehebung](#fehlerbehebung)
- [Referenzen](#referenzen)

---

## Quick Links

- Server-Befehle: [SERVER_COMMANDS.md](SERVER_COMMANDS.md)
Expand Down Expand Up @@ -296,6 +325,12 @@ Details zum sicheren Simulations-Workflow findest du in **[SIMULATION.md](SIMULA
- Proxmox-Wiki: <https://pve.proxmox.com/wiki/Main_Page>
- Mojang Bedrock Server: <https://www.minecraft.net/en-us/download/server/bedrock>

## ⭐ Star-Verlauf

Wenn dir dieses Projekt Zeit gespart hat: Ein ⭐ hilft anderen, es zu finden, und motiviert zur weiteren Pflege.

[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date)

## Lizenz

[MIT](LICENSE)
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@

---

## ✨ Why this repo?

- 🚀 **One-command install** — a single script provisions a production-ready Minecraft server (Java **or** Bedrock) on Proxmox in minutes.
- 🧩 **VM *and* LXC/CT** — supports both Proxmox virtualization models, plus a ready-made CT helper for Bedrock.
- 🔄 **Self-updating** — `update.sh` pulls the latest **stable** PaperMC build via the new **Fill v3 API** with SHA256 + size validation.
- 🔒 **Secure by default** — verified downloads, random CT passwords, UFW firewall guidance, and integrity checks (no HTML error pages saved as `server.jar`).
- 🧠 **Auto-sized JVM** — memory is scaled to the host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, capped at 16 G) — no manual tuning required.
- 🛡️ **CI-linted** — every shell script is checked with ShellCheck on each push.
- 🇩🇪🇬🇧 **Bilingual docs** — full English and German documentation, kept in sync.

---

## 📑 Table of Contents

- [Requirements](#-requirements)
- [Introduction](#introduction)
- [Quickstart](#quickstart) — [VM](#vm-dhcp) · [LXC/CT](#lxcct) · [Bedrock](#bedrock)
- [Backups](#-backups)
- [Auto-Update](#-auto-update)
- [Configuration](#configuration)
- [Integrity & Firewall](#integrity--firewall)
- [Proxmox CT Helper (Bedrock)](#proxmox-ct-helper-bedrock)
- [PaperMC API Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3)
- [Admin/Commands](#-admincommands)
- [Troubleshooting](#troubleshooting)
- [References](#references)

---

## Quick Links

- Server Commands: [SERVER_COMMANDS.md](SERVER_COMMANDS.md)
Expand Down Expand Up @@ -297,6 +326,12 @@ For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**.
- Proxmox Wiki: <https://pve.proxmox.com/wiki/Main_Page>
- Mojang Bedrock Server: <https://www.minecraft.net/en-us/download/server/bedrock>

## ⭐ Star History

If this project saved you time, a ⭐ helps others discover it and motivates continued maintenance.

[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date)

## License

[MIT](LICENSE)
Loading