Introduction
Welcome to the Trexzactyl Installer documentation. This automated installation suite simplifies the deployment of Trexzactyl Panel and its components.
What is Trexzactyl?
Trexzactyl is a modern, high-performance game server management panel forked from Jexactyl. It offers:
- Advanced authentication and security
- Integrated billing system (Stripe + PayPal)
- Clean, user-friendly interface
- Built with PHP, Laravel, TypeScript, and React
- Fully open-source and community-driven
What is the Installer?
The Trexzactyl Installer is an automated installation suite that handles:
- Panel Installation: Complete panel setup with all dependencies
- Wings Daemon: Docker-based server control plane
- Database Configuration: MariaDB setup and optimization
- SSL Certificates: Automatic Let's Encrypt integration
- phpMyAdmin: Optional database management interface
- Updates: Safe update procedures for all components
- Uninstallation: Clean removal when needed
Key Features
Interactive Menu System
Simple numbered menu for all operations:
- Install Panel
- Install Wings
- Install Database Host
- Install phpMyAdmin
- Update Panel
- Update Wings
- Uninstall
- Test Installation
Automated Setup
The installer handles:
- Dependency installation
- Service configuration
- Firewall rules
- SSL certificate generation
- Database creation
- User permissions
- Systemd services
Safety Features
- Pre-installation checks
- Backup recommendations
- Rollback capabilities
- Validation steps
- Error handling
- Detailed logging
Architecture
Components
┌─────────────────┐
│ Trexzactyl │ ← Web interface (Laravel + React)
│ Panel │
└────────┬────────┘
│
│ API Communication
│
┌────────▼────────┐
│ Wings │ ← Server control (Go + Docker)
│ Daemon │
└────────┬────────┘
│
│ Container Management
│
┌────────▼────────┐
│ Game Servers │ ← Docker containers
│ (Minecraft, │
│ etc.) │
└─────────────────┘
Technology Stack
Panel:
- PHP 8.1+
- Laravel 10
- React 18
- TypeScript
- Tailwind CSS
- MariaDB 10.11
Wings:
- Go 1.21+
- Docker 24+
- SFTP server
- WebSocket support
Web Server:
- Nginx
- PHP-FPM
- Let's Encrypt SSL
System Requirements
Minimum Requirements
- OS: Ubuntu 20.04/22.04/24.04 or Debian 11/12
- RAM: 2GB minimum (4GB recommended)
- Disk: 10GB minimum (20GB+ recommended)
- CPU: 2 cores minimum
- Network: Public IP address
- Access: Root or sudo privileges
For Production
- RAM: 4GB+ (8GB for high traffic)
- Disk: SSD with 50GB+
- CPU: 4+ cores
- Bandwidth: 100Mbps+
- Domain: Valid domain name for SSL
Quick Start
Get started in minutes:
bash <(curl -s http://installer.trexz.xyz/install.sh)
Follow the interactive menu to:
- Install Panel
- Install Wings
- Configure SSL
- Create your first server
See the Quick Start Guide for detailed steps.
Documentation Structure
Getting Started
- Introduction - You are here
- Requirements - System requirements
- Quick Start - Fast installation guide
Installation
- Panel Installation - Complete panel setup
- Wings Installation - Wings daemon setup
- Database Setup - MariaDB configuration
- SSL Configuration - HTTPS setup
Management
- Updates - Keeping everything current
- Backups - Data protection
- Monitoring - System monitoring
Additional Features
- phpMyAdmin - Database management
- Queue Worker - Background jobs
- Email Configuration - SMTP setup
- Firewall - Security configuration
Troubleshooting
- Common Issues - Problem solving
- Error Messages - Error reference
- Logs - Log locations
Maintenance
- Uninstall - Clean removal
Support
Need help?
- Documentation: You're reading it!
- GitHub Issues: Report bugs
- Discord: Join community
- Panel Docs: Main documentation
Contributing
The installer is open-source and welcomes contributions:
- Report bugs
- Suggest features
- Submit pull requests
- Improve documentation
Visit the GitHub repository to contribute.
License
The Trexzactyl Installer is open-source software licensed under the MIT License.
Next Steps
Ready to install? Head to the Quick Start Guide to begin!