From 8425ecdfead21317016dcc1edbfab40433e3e473 Mon Sep 17 00:00:00 2001 From: jonny Date: Sat, 16 May 2026 12:57:52 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 206 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 205 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9eed682..ada6ec1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,206 @@ # MinePanel -## Readme coming soon \ No newline at end of file + +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 + +```bash +git clone https://github.com/Ketbome/minepanel.git +cd minepanel +docker compose up -d +``` + +Open the panel in your browser: + +```txt +http://localhost:3000 +``` + +--- + +# Configuration + +Create a `.env` file to customize settings. + +Example: + +```env +JWT_SECRET=your_secret_here + +FRONTEND_PORT=3000 +BACKEND_PORT=8091 + +BASE_DIR=$PWD +``` + +Generate a secure JWT secret: + +```bash +openssl rand -base64 32 +``` + +--- + +# Updating + +```bash +git pull +docker compose pull +docker compose up -d +``` + +--- + +# Development + +Run development environment: + +```bash +docker compose -f docker-compose.development.yml up --build -d +``` + +Single-container mode: + +```bash +docker compose -f docker-compose.single.yml up -d +``` + +--- + +# Reverse Proxy / SSL + +MinePanel works with: +- Nginx Proxy Manager +- nginx-proxy +- Traefik + +Example: + +```yaml +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. \ No newline at end of file