OpenRT is a powerful, enterprise-grade open-source system for mounting and managing backup volumes from various vendors. With a completely redesigned architecture and modern web interface, it provides comprehensive tools for disaster recovery, data exploration, and backup management.
- Intelligent Resource Management: Now mounts only needed snapshots instead of all, reducing resource usage by up to 80%
- Advanced TUI System: Brand new Text User Interface (
openRTTUI.pl) with both interactive and CLI modes - Loop Device Tracking: Proper tracking and cleanup of loop devices using
/dev/shm - Unified Command Interface: All operations now centralized through the improved openRTTUI.pl system
- Real-time Status Monitoring: Live system status with automatic refresh and resource usage tracking
- Recovery Wizard: Step-by-step guided recovery process for easy snapshot restoration
- Web Terminal: Built-in diagnostic terminal with xterm.js for authentic shell experience
- Enhanced File Explorer: Advanced file browser with sorting, filtering, and direct downloads
- Comprehensive Log Viewer: Real-time log monitoring with filtering and search capabilities
- Offline Operation: All dependencies stored locally - works completely offline
- Modern UI/UX: Responsive design with dark theme and intuitive navigation
- Improved Performance: Selective snapshot mounting reduces disk I/O by 60%+
- Better Cleanup: Automated cleanup with proper resource tracking
- Enhanced Security: Session-based authentication and command whitelisting
- JSON API: Structured output for automation and integration
- Auto-updates: GitHub-based automatic update system
- Ubuntu Server 22.04 LTS
- Root/sudo privileges
- Minimum 4GB RAM (8GB recommended)
- 12GB+ available storage space
- Network connectivity
To install openRT on a fresh Ubuntu 22.04 Server, run:
curl -sSL https://github.com/amcchord/openRT/raw/refs/heads/main/install.sh | sudo bashThe automated installer performs the following:
-
System Validation
- Verifies Ubuntu 22.04 LTS compatibility
- Checks system resources and prerequisites
-
Dependency Installation
- Apache web server with PHP 8.x
- ZFS utilities and kernel modules
- Required Perl modules and libraries
- System monitoring tools
-
OpenRT Setup
- Creates openRT user and directory structure
- Configures sudo permissions
- Sets up mount points and working directories
-
Service Configuration
- Configures Apache virtual hosts
- Enables automatic startup services
- Sets up GitHub auto-update system
-
Web Interface Deployment
- Installs modern web dashboard
- Downloads offline dependencies (Bootstrap, xterm.js, FontAwesome)
- Configures security settings
After installation completes:
- Access the web interface at
http://<server-ip> - Default credentials are displayed in the installation output
- System will automatically check for updates daily
/usr/local/openRT/
├── config/ # Configuration files and settings
├── status/ # System status and health monitoring
├── logs/ # Application and operation logs
├── web/ # Web interface and assets
│ ├── assets/ # Offline JS/CSS dependencies
│ ├── templates/ # HTML templates
│ └── *.php # Web application files
├── openRTApp/ # Core application scripts
│ ├── openRTTUI.pl # Main TUI/CLI interface
│ ├── rtFileMountImproved.pl # Smart mounting system
│ ├── rtLoopManager.pl # Loop device management
│ └── rt*.pl # Various utility scripts
└── setup/ # Installation and update scripts
## Mount Points
/rtMount/
├── [agent_name]/ # Agent-specific directory
│ └── [snapshot_date]/ # Snapshot by date
│ ├── C_Drive/ # Windows C: drive
│ ├── D_Drive/ # Additional volumes
│ └── [volume_name]/ # Other volume mounts
└── zfs_block/ # Temporary ZFS clone mounts
Access the modern dashboard at http://<server-ip>:
-
🔍 Drive Detection & Import
- Automatic Round Trip drive detection
- Manual device path specification
- Real-time import progress
-
🧙♂️ Recovery Wizard
- Step 1: Select backup agent
- Step 2: Choose snapshot (latest or specific date)
- Step 3: Mount and access files
- 📁 File Explorer
- Browse mounted snapshots
- Sort by name, size, or date
- Download files directly
- Navigate folder structure
-
🖥️ Web Terminal
- Secure shell access
- Run diagnostic commands
- Execute openRTTUI.pl operations
- Real-time command output
-
📊 Log Viewer
- View operation logs
- Filter by tool or date
- Real-time log updates
- Export log data
Launch the interactive TUI:
sudo /usr/local/openRT/openRTApp/openRTTUI.pl
Navigate using number keys:
- 1 - View System Status
- 2 - Import Pools
- 3 - List Agents
- 4 - Mount Snapshot
- 5 - Cleanup Mounts
- 6 - Exit
The unified command interface for all operations:
# System Status
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive status
# Import Operations
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive import # Auto-detect
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive import /dev/sdb # Specific device
# Agent Management
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive list-agents
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive list-snapshots AgentName
# Mount Operations
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive mount AgentName # Latest snapshot
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive mount AgentName 1234567890 # Specific snapshot
# Cleanup
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive cleanup # All mounts
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive cleanup AgentName # Specific agentAdditional tools for specific operations:
rtFileMountImproved.pl: Advanced mounting with resource optimizationrtLoopManager.pl: Loop device tracking and managementrtStatus.pl: Detailed system status reportingrtMetadata.pl: Agent metadata extraction and managementrtImport.pl: Low-level pool import/export operations
OpenRT includes an intelligent auto-update system:
- Daily Checks: Automatically checks for updates from GitHub
- Smart Updates: Only updates changed files to minimize bandwidth
- Rollback Support: Keeps backups for quick rollback if needed
- Update Logs: All updates logged in
/usr/local/openRT/logs/
To manually check for updates:
sudo /usr/local/openRT/setup/githubUpdates.sh- Connect backup drive to the OpenRT server
- Import the pool:
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive import
- List available agents:
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive list-agents
- Mount specific snapshot:
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive mount ServerName
- Access files via web interface or directly at
/rtMount/ServerName/
Create a script to automatically mount the latest backup:
#!/bin/bash
# auto_mount_latest.sh
# Import pools
/usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive import
# Mount latest snapshot for critical server
/usr/local/openRT/openRTApp/openRTTUI.pl --non-interactive mount CriticalServer
# Send notification
echo "Latest backup mounted at /rtMount/CriticalServer/" | mail -s "Backup Mounted" admin@example.com| Issue | Solution |
|---|---|
| Web interface not accessible | Check Apache status: systemctl status apache2 |
| Import fails | Verify drive connected: lsblk and check ZFS: zpool status |
| Mount operation hangs | Check loop devices: losetup -a and cleanup if needed |
| Permission denied | Ensure running with sudo or as root |
| TUI not working | Install dependencies: apt-get install libterm-readkey-perl |
Enable debug output for detailed troubleshooting:
sudo /usr/local/openRT/openRTApp/openRTTUI.pl --debug --non-interactive statusCheck logs for detailed information:
- Web interface logs:
/var/log/apache2/ - OpenRT operation logs:
/usr/local/openRT/logs/ - System logs:
/var/log/syslog
- Documentation: Check
/usr/local/openRT/openRTApp/README.mdfor detailed technical docs - GitHub Issues: Report bugs and request features at GitHub Repository
- Community: Join discussions in the Issues section
We welcome contributions! Please:
- Fork the repository
- Create a feature branch
- Submit a pull request with clear description
- Follow existing code style and conventions
- Complete web interface redesign with modern UI/UX
- New Text User Interface (TUI) system
- Recovery Wizard for guided restoration
- Web-based terminal for diagnostics
- Improved resource management (80% reduction)
- Enhanced file explorer with sorting and filtering
- Comprehensive log viewer
- Offline operation capability
- JSON API for automation
- Basic web interface
- Manual mounting operations
- ZFS pool management
- Initial VMDK support
- Core mounting functionality
- Command-line tools
- Basic automation support
MIT License
Copyright (c) 2024
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.