minecraft-server-proxmox/README.md
2025-06-23 10:58:40 +02:00

216 lines
4.8 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🧱️ Minecraft Server on Proxmox 🌍
![⛏️ Minecraft Server Setup](https://github.com/TimInTech/minecraft-server-Proxmox/blob/main/minecraft-setup.png?raw=true)
This repository provides a guide and automated scripts to set up a **Minecraft server** on **Proxmox** using either a **Virtual Machine (VM)** or an **LXC container**.
---
## 🔗 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
---
## 💎 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
### 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 ⛏️
```bash
wget https://raw.githubusercontent.com/TimInTech/minecraft-server-Proxmox/main/setup_minecraft.sh
chmod +x setup_minecraft.sh
./setup_minecraft.sh
```
---
## 🛠️ 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
### 2⃣ Install Required Dependencies ⚒️
```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 🛠️
```bash
wget https://raw.githubusercontent.com/TimInTech/minecraft-server-Proxmox/main/setup_minecraft_lxc.sh
chmod +x setup_minecraft_lxc.sh
./setup_minecraft_lxc.sh
```
---
## 🔧 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?
```bash
sudo -u minecraft screen -r
```
If needed:
```bash
sudo -u minecraft screen -ls
sudo -u minecraft bash /opt/minecraft/start.sh
```
### 🔄 How do I update the server?
#### Java Edition:
```bash
cd /opt/minecraft
sudo -u minecraft ./update.sh
```
If it's missing:
```bash
sudo 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
```
Then:
```bash
sudo 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
```bash
apt install -y openjdk-21-jre-headless
systemctl restart minecraft
```
### 2⃣ Missing `start.sh`
```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 (UFW) Setup
```bash
ufw allow 25565/tcp
ufw allow 25565/tcp6
ufw enable
```
---
## 🤝 Contribute 🌟
* Found a bug? 🐛 [Open an Issue](https://github.com/TimInTech/minecraft-server-Proxmox/issues)
* Want to improve the script? ⚙️ Submit a Pull Request
💎 **Happy crafting!** 🎮