New Readme
This commit is contained in:
@@ -21,24 +21,9 @@ MinePanel allows you to create, manage and monitor Minecraft servers through a c
|
|||||||
- CurseForge Modpacks
|
- CurseForge Modpacks
|
||||||
- and more
|
- 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
|
### Live Monitoring
|
||||||
- Real-time console logs
|
- Real-time console logs
|
||||||
- CPU and RAM monitoring
|
- 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
|
### Backups
|
||||||
- Automatic backups
|
- Automatic backups
|
||||||
@@ -55,104 +40,42 @@ MinePanel allows you to create, manage and monitor Minecraft servers through a c
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Docker
|
- Minecraft Server and a free Port
|
||||||
- Docker Compose
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
- Download the jar from the [Modrinth Page](https://modrinth.com/plugin/minepanel)
|
||||||
git clone https://github.com/Ketbome/minepanel.git
|
- Start the server and wait for the panel to initialize
|
||||||
cd minepanel
|
|
||||||
docker compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Open the panel in your browser:
|
Open the panel in your browser:
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
http://localhost:3000
|
http://ip:3000
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Configuration
|
# Compile from Source
|
||||||
|
|
||||||
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
|
```bash
|
||||||
openssl rand -base64 32
|
git clone https://git.winniepat.de/winnie/MinePanel.git
|
||||||
|
cd MinePanel
|
||||||
|
gradlew build
|
||||||
```
|
```
|
||||||
|
- And copy the generated `build/libs/MinePanel.jar` to your server
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# 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
|
# Reverse Proxy / SSL
|
||||||
|
|
||||||
MinePanel works with:
|
MinePanel can be secured with:
|
||||||
- Nginx Proxy Manager
|
- Nginx Proxy Manager
|
||||||
- nginx-proxy
|
- nginx-proxy
|
||||||
- Traefik
|
- A Let's Encrypt certificate
|
||||||
|
- Your own SSL certificate
|
||||||
|
|
||||||
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 | ✅ |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -180,11 +103,9 @@ Do not expose the panel publicly without:
|
|||||||
|
|
||||||
# Roadmap
|
# Roadmap
|
||||||
|
|
||||||
- [ ] Plugin marketplace
|
- [ ] Addon marketplace
|
||||||
- [ ] One-click modpack installs
|
|
||||||
- [ ] Scheduled tasks
|
- [ ] Scheduled tasks
|
||||||
- [ ] Multi-user permissions
|
- [ ] Multi-user permissions
|
||||||
- [ ] Cluster support
|
|
||||||
- [ ] Metrics dashboard
|
- [ ] Metrics dashboard
|
||||||
- [ ] Public API
|
- [ ] Public API
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user