Update README.md

This commit is contained in:
==TIM.©.B == 2025-06-23 10:50:00 +02:00 committed by GitHub
parent 547c74ee23
commit 573a6f53ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

216
README.md
View file

@ -1,4 +1,4 @@
# 🧱 **Minecraft Server on Proxmox** 🌍
# 🧱 **Minecraft Server on Proxmox** 🌍
![⛏️ Minecraft Server Setup](https://github.com/TimInTech/minecraft-server-Proxmox/blob/main/minecraft-setup.png?raw=true)
@ -6,50 +6,61 @@ This repository provides a guide and automated scripts to set up a **Minecraft s
---
## 🔗 **Support This Project** 💎
If you find this guide helpful, consider purchasing through this affiliate link:
**⛏️ [NiPoGi AK1PLUS Mini PC Intel Alder Lake-N N100](https://amzn.to/3FvH4GX)**
## 🔗 **Support This Project** 💎
If you find this guide helpful, consider purchasing through this affiliate link:
**⛏️ [NiPoGi AK1PLUS Mini PC Intel Alder Lake-N N100](https://amzn.to/3FvH4GX)**
Using this link supports the project at no additional cost to you. Thank you! 🙌
---
## 📌 **Features** 🗺️
**Automated installation** of Minecraft Java/Bedrock servers
✅ Works with **Proxmox VM** or **LXC container**
**Performance optimizations** included (RAM allocation, CPU prioritization)
✅ Customizable settings (world generation, plugins, mods)
**Troubleshooting guide included** for common issues
## 📌 **Features** 📜
**Automated installation** of Minecraft Java/Bedrock servers
✅ Works with **Proxmox VM** or **LXC container**
**Performance optimizations** included (RAM allocation, CPU prioritization)
✅ Customizable settings (world generation, plugins, mods)
**Troubleshooting guide included** for common issues
---
## 💎 **Installation Guide (Proxmox VM)** 🖥️
### **1⃣ Create a Proxmox VM** 🛠️
- Open Proxmox Web Interface → Click on **"Create VM"**
- **General Settings**:
- Name: `Minecraft-Server`
- **OS Selection**:
- Use a **Debian 11/12** or **Ubuntu 24.04** ISO image
- **System Configuration**:
- BIOS: **OVMF (UEFI) or SeaBIOS**
- Machine Type: **q35** (recommended)
- **Disk & Storage**:
- **20GB+ Storage** (depending on world size)
- Storage Type: **`virtio`** (recommended)
- **CPU & RAM**:
- 2 vCPUs (recommended: 4)
- 4GB RAM (recommended: 8GB)
- **Network**:
- Model: **VirtIO**
- Enable **QEMU Guest Agent** after installation
### **1⃣ Create a Proxmox VM** 💠
* Open Proxmox Web Interface → Click on **"Create VM"**
* **General Settings**:
* Name: `Minecraft-Server`
* **OS Selection**:
* Use a **Debian 11/12** or **Ubuntu 24.04** ISO image
* **System Configuration**:
* BIOS: **OVMF (UEFI) or SeaBIOS**
* Machine Type: **q35** (recommended)
* **Disk & Storage**:
* **20GB+ Storage** (depending on world size)
* Storage Type: **`virtio`** (recommended)
* **CPU & RAM**:
* 2 vCPUs (recommended: 4)
* 4GB RAM (recommended: 8GB)
* **Network**:
* Model: **VirtIO**
* Enable **QEMU Guest Agent** after installation
### **2⃣ Install Dependencies** ⚙️
### **2⃣ Install Dependencies** ⚙️
```bash
apt update && apt upgrade -y
apt install -y curl wget nano screen unzip git openjdk-21-jre-headless
```
### **3⃣ Run the Minecraft Server Setup Script** ⛏️
### **3⃣ Run the Minecraft Server Setup Script** ⛏️
```bash
wget https://raw.githubusercontent.com/TimInTech/minecraft-server-Proxmox/main/setup_minecraft.sh
chmod +x setup_minecraft.sh
@ -58,37 +69,46 @@ chmod +x setup_minecraft.sh
---
## 🛠️ **Installation Guide (Proxmox LXC Container)** 📦
## 🛠️ **Installation Guide (Proxmox LXC Container)** 📆
### **1⃣ Create a Proxmox LXC Container** 🧱
- Open Proxmox Web Interface → Click on **"Create CT"**
- **General Settings**:
- Name: `Minecraft-LXC`
- Set root user **password**
- **Template Selection**:
- Choose a **Debian 11/12** or **Ubuntu 24.04** template
- **Resources**:
- CPU: 2 vCPUs (recommended: 4)
- RAM: 4GB (recommended: 8GB)
- Disk Storage: 10GB (recommended: 20GB)
- **Network Settings**:
- Network Device: `eth0`
- Bridge: `vmbr0` *(adjust as needed)*
- IPv4: Static (e.g. `192.168.0.222/24`)
- Gateway (IPv4): typically `192.168.0.1`
- Firewall: Enable (optional)
- **Advanced Settings**:
- Enable **"Nesting"** (required for Java & systemd)
- Disable **"Unprivileged Container"** if needed
### **1⃣ Create a Proxmox LXC Container** 🧱️
* Open Proxmox Web Interface → Click on **"Create CT"**
* **General Settings**:
* Name: `Minecraft-LXC`
* Set root user **password**
* **Template Selection**:
* Choose a **Debian 11/12** or **Ubuntu 24.04** template
* **Resources**:
* CPU: 2 vCPUs (recommended: 4)
* RAM: 4GB (recommended: 8GB)
* Disk Storage: 10GB (recommended: 20GB)
* **Network Settings**:
* Network Device: `eth0`
* Bridge: `vmbr0` *(adjust as needed)*
* IPv4: Static (e.g. `192.168.0.222/24`)
* Gateway (IPv4): typically `192.168.0.1`
* Firewall: Enable (optional)
* **Advanced Settings**:
* Enable **"Nesting"** (required for Java & systemd)
* Disable **"Unprivileged Container"** if needed
### **2⃣ Install Required Dependencies** ⚒️
Log into the container and install:
### **2⃣ Install Required Dependencies** ⚒️
Log into the container and install:
```bash
apt update && apt upgrade -y
apt install -y curl wget nano screen unzip git openjdk-21-jre-headless
```
### **3⃣ Run the LXC Setup Script** 🧰
### **3⃣ Run the LXC Setup Script** 🛠️
```bash
wget https://raw.githubusercontent.com/TimInTech/minecraft-server-Proxmox/main/setup_minecraft_lxc.sh
chmod +x setup_minecraft_lxc.sh
@ -97,47 +117,105 @@ chmod +x setup_minecraft_lxc.sh
---
## 🔍 **Troubleshooting & Solutions** 🛑
## 🔧 Post-Installation Notes
### ✅ Can I install this as a non-root user?
Yes root is only needed during setup (e.g. to create the `minecraft` user). After installation, all operations (start, stop, update) can and should be done as the `minecraft` user.
### 🎮 How do I access the Minecraft console?
If you're using the default setup, the server runs in a `screen` session under the `minecraft` user:
```bash
sudo -u minecraft screen -r
```
If needed, list running sessions:
```bash
sudo -u minecraft screen -ls
```
### 🔄 How do I update the server?
#### Java Edition:
Use the included `update.sh` script inside `/opt/minecraft/`:
```bash
cd /opt/minecraft
sudo -u minecraft ./update.sh
```
If it's missing, create it like this:
```bash
nano /opt/minecraft/update.sh
```
Paste:
```bash
#!/bin/bash
wget -O server.jar https://api.papermc.io/v2/projects/paper/versions/1.20.4/builds/416/downloads/paper-1.20.4-416.jar
```
Dann:
```bash
chmod +x /opt/minecraft/update.sh
```
#### Bedrock Edition:
Manual update required download the latest `.zip` from the official site and replace the old one. *(Due to licensing restrictions, automatic download is not included.)*
---
## 🔍 **Troubleshooting & Solutions** 🚩
### 1⃣ Java Version Error (Unsupported Class Version)
### **1⃣ Java Version Error (Unsupported Class Version)** 🚫
**Error:** `org/bukkit/craftbukkit/Main has been compiled by a more recent version of the Java Runtime.`
#### **Solution:** Install the correct Java version
```bash
apt install -y openjdk-21-jre-headless
```
Restart the server:
```bash
systemctl restart minecraft
```
### **2⃣ Server Not Starting (`start.sh` missing)** ⚠️
### 2⃣ Server Not Starting (`start.sh` missing)
```bash
cd /opt/minecraft
nano start.sh
```
Paste:
```bash
#!/bin/bash
java -Xms2G -Xmx4G -jar server.jar nogui
```
Then:
```bash
chmod +x start.sh
./start.sh
```
### **3⃣ Firewall Issues (`ufw` inactive)** 🔥
### 3⃣ Firewall Issues (`ufw` inactive)
```bash
ufw allow 25565/tcp
ufw allow 25565/tcp6
ufw allow 25565/tcp
ufw allow 25565/tcp6
ufw enable
```
---
## 🤝 **Contribute** 🌟
- Found a bug? 🐛 **Open an Issue**
- Want to improve the script? ⚙️ **Submit a Pull Request**
## 🤝 **Contribute** 🌟
💎 **Happy crafting!** 🎮
* Found a bug? 🦛 **Open an Issue**
* Want to improve the script? ⚙️ **Submit a Pull Request**
💎 **Happy crafting!** 🎮