MinePanel/README.md

MinePanel

A modern self-hosted Minecraft server management panel powered by Docker.

MinePanel allows you to create, manage and monitor Minecraft servers through a clean web interface without manually handling Docker containers or constantly using SSH.

---

Features

Server Management

• Create and manage multiple Minecraft servers
• Start, stop and restart servers instantly
• Supports:
  • Vanilla
  • Paper
  • Spigot
  • Purpur
  • Forge
  • Fabric
  • CurseForge Modpacks
  • and more

Docker-Based Infrastructure

• Every server runs inside its own Docker container
• Easy deployment and updates
• Multi-architecture support:
  • x86_64
  • ARM64
  • Raspberry Pi
  • Apple Silicon

Live Monitoring

• Real-time console logs
• CPU and RAM monitoring
• Automatic crash detection

File Management

• Built-in file browser
• Edit configuration files directly in the browser
• Upload and manage files without FTP

Backups

• Automatic backups
• Easy restore support

Web Interface

• Modern responsive UI
• Mobile friendly
• Multi-language support

---

Quick Start

Requirements

• Docker
• Docker Compose

---

Installation

git clone https://github.com/Ketbome/minepanel.git
cd minepanel
docker compose up -d

Open the panel in your browser:

http://localhost:3000

---

Configuration

Create a .env file to customize settings.

Example:

JWT_SECRET=your_secret_here

FRONTEND_PORT=3000
BACKEND_PORT=8091

BASE_DIR=$PWD

Generate a secure JWT secret:

openssl rand -base64 32

---

Updating

git pull
docker compose pull
docker compose up -d

---

Development

Run development environment:

docker compose -f docker-compose.development.yml up --build -d

Single-container mode:

docker compose -f docker-compose.single.yml up -d

---

Reverse Proxy / SSL

MinePanel works with:

• Nginx Proxy Manager
• nginx-proxy
• Traefik

Example:

services:
  frontend:
    environment:
      - VIRTUAL_HOST=panel.example.com
      - LETSENCRYPT_HOST=panel.example.com

---

Platform Support

Platform	Supported
Linux	✅
Windows (WSL2)	✅
macOS	✅
Raspberry Pi	✅
ARM64	✅

---

Tech Stack

• Docker
• Next.js
• Node.js
• REST API
• WebSocket Console

---

Security Notice

MinePanel is still under active development.

Do not expose the panel publicly without:

• HTTPS
• strong passwords
• firewall protection
• proper reverse proxy configuration

---

Roadmap

• Plugin marketplace
• One-click modpack installs
• Scheduled tasks
• Multi-user permissions
• Cluster support
• Metrics dashboard
• Public API

---

Contributing

Pull requests, bug reports and feature suggestions are welcome.

1. Fork the repository
2. Create a new branch
3. Commit your changes
4. Open a pull request

---

License

This project is licensed under the MIT License.