🏠 Home Panel

Enterprise-Grade Homelab Management Dashboard

Beautiful • Secure • Feature-Rich • Cross-Platform

🚀 Quick Start • 📚 Documentation • 🐛 Issues • ⭐ Star

---

✨ What is Home Panel?

Home Panel is a powerful, all-in-one web dashboard for managing your homelab infrastructure. Built with security-first principles and designed for both Windows and Linux servers.

Perfect for:

• 🏠 Home server enthusiasts
• 💼 Small business IT
• 🧪 Development environments
• 🎓 Learning DevOps

---

🎯 Key Features

📊 Monitoring Real-time system stats CPU, Memory, Disk, Network Temperature sensors Power/Battery status Historical graphs Customizable alerts	🐳 Container & Process Docker management PM2 process control Service manager (systemd/Windows) Container logs Resource limits Auto-restart policies
📁 File Management Web-based file browser Upload & download Text editor Delete & rename Safe path restrictions 10MB upload limit	💻 Terminal Browser-based shell Command execution Auto-reconnect Command history Output streaming Dangerous command blocking

Advanced Features

• 📈 Historical Graphs - CPU & Memory usage over time with Chart.js
• 🔔 Smart Alerts - Configurable thresholds with Telegram notifications
• 📝 Centralized Logs - View logs from Panel, Docker, PM2 in one place
• 🌐 Network Monitor - Real-time bandwidth, IP addresses, connections
• 🔋 Power Monitoring - Battery status & charging state
• ☁️ Cloudflare Integration - [NEW] Sync Tunnels & DNS directly from Cloudflare API
• 🔄 Auto-Sync - Real-time status of Cloudflare Tunnels (Online/Down)

Security & Reliability ⭐

• ✅ Rate limiting (API & login)
• ✅ Input validation & sanitization
• ✅ Path traversal protection
• ✅ Command injection prevention
• ✅ Session security (bcrypt)
• ✅ Audit logging
• ✅ Helmet security headers

Security Score: 9/10 ⭐

---

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/yourusername/home-panel.git
cd home-panel

# Install dependencies
cd backend
npm install

# Start the server
npm start

Access: http://localhost:9689

Default Login:

• Username: admin
• Password: SecurePass2026!

⚠️ Change password immediately!

---

📸 Screenshots

Dashboard

Docker Management

Web Terminal

---

📚 Documentation

• 📖 Full Documentation
• 🐧 Linux Compatibility
• 🔐 Security Guide
• 📱 Telegram Setup
• ⚙️ PM2 Configuration
• 🔄 Auto-Restart Setup

---

⚙️ Configuration

Basic Setup

Edit config/config.json:

{
  "server": { "port": 9689, "host": "0.0.0.0" },
  "session": { "secret": "your-random-secret" },
  "alerts": {
    "cpu": { "warning": 80, "critical": 90 },
    "memory": { "warning": 75, "critical": 90 }
  }
}

Environment Variables

Copy .env.example to .env:

cp .env.example .env

Edit .env for production secrets.

---

🛠️ Tech Stack

Component	Technology
Backend	Node.js + Express
Frontend	Vanilla JS + Tailwind CSS
Database	JSON file-based
Charts	Chart.js
Icons	Font Awesome
Container	dockerode
Process	PM2 API
System	systeminformation
Alerts	Telegram Bot API

---

🔒 Security Best Practices

For Production:

1. HTTPS - Use reverse proxy (Nginx/Caddy)
2. Firewall - Restrict to trusted IPs
3. Passwords - Change defaults immediately
4. env - Use .env for secrets
5. Updates - Keep dependencies current

Example Nginx Config:

server {
    listen 443 ssl;
    server_name panel.yourdomain.com;
    
    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;
    
    location / {
        proxy_pass http://localhost:9689;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
    }
}

Cloudflare API Integration (New!)

1. Go to Panel Settings page.
2. Enter your Cloudflare API Token (Permissions: Zone:Read, Tunnel:Read).
3. Click Save & Verify.
4. Your Tunnels list will now auto-sync with Cloudflare!

---

🐛 Troubleshooting

Common Issues

Q: Port 9689 already in use?
A: Change port in config/config.json

Q: Terminal won't connect?
A: Check WebSocket isn't blocked, verify authentication

Q: Permission denied on Linux?
A: Add user to docker group: sudo usermod -aG docker $USER

Q: Upload fails?
A: Check disk space & file size (<10MB)

---

🤝 Contributing

We love contributions! See CONTRIBUTING.md for guidelines.

Ways to contribute:

• 🐛 Report bugs
• 💡 Suggest features
• 📝 Improve docs
• 🔧 Submit PRs

---

📊 Project Stats

• Total Features: 20+
• Security Score: 9/10
• Cross-Platform: Windows & Linux
• Dependencies: Minimal & secure
• Bundle Size: ~10MB (with deps)

---

📜 License

MIT License - Free & Open Source

---

🌟 Support

• ⭐ Star this repo if you find it useful
• 🐛 Report bugs via Issues
• 💬 Discuss in GitHub Discussions
• 🔔 Watch for updates

---

🙏 Acknowledgments

Built with ❤️ using:

• Express.js
• Tailwind CSS
• Chart.js
• systeminformation

---

Made for the Homelab Community 🏠

Report Bug • Request Feature • Documentation

⭐ Don't forget to star the repo!