Compare commits
3 Commits
e3d2a9f3de
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 75c08cf37a | |||
| d95aa04e88 | |||
| bbbd65187d |
@@ -19,24 +19,9 @@ MinePanel allows you to create, manage and monitor Minecraft servers through a c
|
||||
- Folia
|
||||
- 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
|
||||
@@ -53,116 +38,40 @@ MinePanel allows you to create, manage and monitor Minecraft servers through a c
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker
|
||||
- Docker Compose
|
||||
|
||||
- Minecraft Server and a free Port
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Ketbome/minepanel.git
|
||||
cd minepanel
|
||||
docker compose up -d
|
||||
```
|
||||
- Download the jar from the [Modrinth Page](https://modrinth.com/plugin/minepanel)
|
||||
- Start the server and wait for the panel to initialize
|
||||
|
||||
Open the panel in your browser:
|
||||
|
||||
```txt
|
||||
http://localhost:3000
|
||||
http://ip: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:
|
||||
# Compile from Source
|
||||
|
||||
```bash
|
||||
openssl rand -base64 32
|
||||
git clone https://git.winniepat.de/winnie/MinePanel.git
|
||||
cd MinePanel
|
||||
gradlew build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
- And copy the generated `build/libs/MinePanel.jar` to your server
|
||||
-
|
||||
---
|
||||
|
||||
# Reverse Proxy / SSL
|
||||
|
||||
MinePanel works with:
|
||||
- Nginx Proxy Manager
|
||||
- nginx-proxy
|
||||
- Traefik
|
||||
MinePanel can be secured with:
|
||||
- Nginx Proxy Manager (easiest option)
|
||||
- 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 | ✅ |
|
||||
|
||||
---
|
||||
|
||||
# Tech Stack
|
||||
|
||||
- Docker
|
||||
- Next.js
|
||||
- Node.js
|
||||
- REST API
|
||||
- WebSocket Console
|
||||
|
||||
---
|
||||
|
||||
# Security Notice
|
||||
|
||||
@@ -178,11 +87,9 @@ Do not expose the panel publicly without:
|
||||
|
||||
# Roadmap
|
||||
|
||||
- [ ] Plugin marketplace
|
||||
- [ ] One-click modpack installs
|
||||
- [ ] Addon marketplace
|
||||
- [ ] Scheduled tasks
|
||||
- [ ] Multi-user permissions
|
||||
- [ ] Cluster support
|
||||
- [ ] Metrics dashboard
|
||||
- [ ] Public API
|
||||
|
||||
|
||||
Reference in New Issue
Block a user