try this shi

This commit is contained in:
2025-10-13 13:53:48 -05:00
commit fc6d1237e9
24 changed files with 1345 additions and 0 deletions

101
QUICKSTART.md Normal file
View File

@@ -0,0 +1,101 @@
# ⚡ Quick Start Guide
Get your Minecraft Dashboard up and running in 3 simple steps!
## Prerequisites
- Docker and Docker Compose installed
- Minecraft server running on `mcnet` network
## 🚀 3-Step Setup
### 1⃣ Start Your Minecraft Server
If not already running, start your Minecraft server with the provided configuration:
```bash
docker-compose -f docker-compose.minecraft.yml up -d
```
### 2⃣ Launch the Dashboard
Simply run:
```bash
./start-dashboard.sh
```
This will:
- Create the `mcnet` network (if it doesn't exist)
- Build the frontend and backend containers
- Start all dashboard services
### 3⃣ Open the Dashboard
Navigate to in your browser:
```
http://localhost:8080
```
## 🎮 Using the Dashboard
### Features:
- **🟢 Server Status** - See if your server is online
- **👥 Player Count** - Monitor active players
- **▶️ Start Button** - Start the Minecraft server
- **⏹️ Stop Button** - Gracefully stop the server
- **🔄 Auto-Refresh** - Updates every 5 seconds
### Controls:
- Click **START SERVER** to boot up your Minecraft server
- Click **STOP SERVER** to safely shut it down (requires confirmation)
- Click **🔄** to manually refresh the status
## 🛑 Stopping the Dashboard
When you're done:
```bash
./stop-dashboard.sh
```
Or manually:
```bash
docker-compose -f docker-compose.dashboard.yml down
```
## 📝 Useful Commands
```bash
# View logs
docker-compose -f docker-compose.dashboard.yml logs -f
# Restart the dashboard
docker-compose -f docker-compose.dashboard.yml restart
# Rebuild after making changes
docker-compose -f docker-compose.dashboard.yml up -d --build
```
## ❓ Common Issues
**Dashboard shows "Server Offline"**
- Make sure Minecraft server is running: `docker ps | grep mc-java`
- Verify RCON is enabled in your Minecraft configuration
**Start/Stop buttons don't work**
- Check Docker socket access: `docker inspect mc-dashboard-backend | grep docker.sock`
**Can't access dashboard**
- Verify port 8080 is not in use: `lsof -i :8080`
- Check if frontend is running: `docker ps | grep mc-dashboard-frontend`
## 📖 Need More Help?
See the full documentation:
- [README.md](README.md) - Complete documentation
- [SETUP.md](SETUP.md) - Detailed setup guide
---
Enjoy your Minecraft Dashboard! 🎮⛏️