Update README to reflect launcher cleanup and recent optimizations
Changes to README.md: Updated Usage Examples: - Replaced outdated multi-level menu paths with new streamlined structure - Updated to match new 6-category main menu (1-6 numbering) - Simplified navigation instructions - Listed actual options available in each category Updated Key Features: - Security & Threat Analysis → Security & Monitoring - Added "Optimized Status Checks" feature - Listed all 14 actual security tools available - Removed references to removed phantom features Updated Recent Updates Section: - Renamed to v2.1 (from v2.2) - Added "December 2025 - Major Cleanup & Optimization" section - Documented launcher streamline (90+ items removed, 64% code reduction) - Documented performance optimizations (cached status checks) - Documented MySQL restore tool features - Listed actual implemented features by category: - Security & Monitoring: 14 tools - Website Diagnostics: 3 tools - Performance Analysis: 5 tools - Backup & Recovery: 11 tools - Updated module counts to reflect reality (41 instead of 38) - Removed references to unimplemented features Key Improvements: - README now accurately reflects what actually exists - No more confusion about phantom features - Clear tool counts for each category - Updated navigation paths match new launcher - Performance improvements documented - All December 2025 updates included
This commit is contained in:
cschantz
@@ -99,12 +99,15 @@ source /root/linux-server-management-toolkit/run.sh
|
||||
|
||||
## ✨ Key Features
|
||||
|
||||
### 🛡️ Security & Threat Analysis
|
||||
- **3-Mode Security Menu**: Analysis / Actions / Live Monitoring
|
||||
### 🛡️ Security & Monitoring
|
||||
- **Bot & Traffic Analyzer**: Full bot/threat analysis with pattern detection
|
||||
- **Live Attack Monitor**: Real-time SOC dashboard with threat classification
|
||||
- **Intelligent cPHulk Setup**: Auto-imports CSF whitelists from all sources
|
||||
- **IP Reputation Tracking**: Centralized cross-module IP intelligence
|
||||
- **Multi-Source Monitoring**: SSH, Web, Firewall, cPHulk integration
|
||||
- **Specialized Monitors**: SSH attacks, web traffic, firewall activity
|
||||
- **IP Reputation Manager**: Centralized cross-module IP intelligence with query/tracking
|
||||
- **Malware Scanner**: ImunifyAV, ClamAV, and Maldet integration
|
||||
- **cPHulk Integration**: Auto-imports CSF whitelists from all sources
|
||||
- **Log Viewers**: Live tail for Apache access/error, mail, and security logs
|
||||
- **Optimized Status Checks**: Uses cached domain status (no redundant HTTP requests)
|
||||
|
||||
### 💾 Backup & Recovery
|
||||
#### Acronis Cyber Protect Integration
|
||||
@@ -158,73 +161,59 @@ source /root/linux-server-management-toolkit/run.sh
|
||||
|
||||
## 🎯 Usage Examples
|
||||
|
||||
### Security Analysis with Live Monitoring
|
||||
### Quick System Health Check
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Security & Threat Analysis
|
||||
# Select: Live Monitoring & Alerts
|
||||
# Select: Live Network Security Monitor
|
||||
# Select: 1) System Health Check
|
||||
```
|
||||
|
||||
### Enable cPHulk with CSF Whitelist
|
||||
### Security Analysis & Monitoring
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Security & Threat Analysis
|
||||
# Select: Security Actions & Fixes
|
||||
# Select: Authentication Security
|
||||
# Select: Enable cPHulk Protection
|
||||
# Select: 2) Security & Monitoring
|
||||
# Options:
|
||||
# - Bot & Traffic Analyzer (full scan or 1-hour quick scan)
|
||||
# - Live Attack Monitor (unified threat intelligence)
|
||||
# - SSH/Web/Firewall attack monitors
|
||||
# - IP Reputation Manager
|
||||
# - Malware Scanner
|
||||
# - Enable cPHulk Protection
|
||||
```
|
||||
|
||||
### Acronis Backup Management
|
||||
### Website Diagnostics
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Backup & Recovery
|
||||
# Select: Check Agent Status (view health, registration, connectivity)
|
||||
# Select: Trigger Manual Backup (with type selection and optimizations)
|
||||
# Select: Manage Protection Plans
|
||||
# Select: 3) Website Diagnostics
|
||||
# Options:
|
||||
# - Website Error Analyzer (comprehensive error detection)
|
||||
# - Fast 500 Error Tracker (500 errors only)
|
||||
# - WordPress Tools (WP-Cron manager)
|
||||
```
|
||||
|
||||
### MySQL Database Restore & Recovery
|
||||
### Performance Analysis
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Backup & Recovery
|
||||
# Select: MySQL/MariaDB Database Restore to SQL
|
||||
# Follow guided wizard:
|
||||
# 1. Provide backup files (ibdata1, ib_logfile*, database folders)
|
||||
# 2. Select database to restore
|
||||
# 3. Configure MySQL settings
|
||||
# 4. Choose Force Recovery level (with intelligent recommendations)
|
||||
# 5. Restore and dump to clean SQL file
|
||||
# Select: 4) Performance Analysis
|
||||
# Options:
|
||||
# - MySQL Query Analyzer (slow query detection)
|
||||
# - Network & Bandwidth Analyzer
|
||||
# - Hardware Health Check
|
||||
# - PHP Configuration Optimizer (per-domain tuning)
|
||||
# - Loadwatch Health Analyzer (1h/6h/24h/7d/30d analysis)
|
||||
```
|
||||
|
||||
### Website Error Analysis
|
||||
### Backup & Recovery
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Website Diagnostics & Troubleshooting
|
||||
# Select: Website Error Analyzer
|
||||
# Choose a cPanel user account to analyze
|
||||
```
|
||||
|
||||
### System Health Check
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: System Diagnostics
|
||||
# Select: System Health Check
|
||||
```
|
||||
|
||||
### Loadwatch System Health Analysis
|
||||
|
||||
```bash
|
||||
bash launcher.sh
|
||||
# Select: Performance & Diagnostics
|
||||
# Select: Loadwatch Health Analyzer
|
||||
# Choose time range: 1h, 6h, 24h, 7d, or 30d
|
||||
# Select: 5) Backup & Recovery
|
||||
# Options:
|
||||
# - Acronis Management (complete backup interface)
|
||||
# - MySQL File Restore (convert DB files to SQL)
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
@@ -241,54 +230,82 @@ nano /root/server-toolkit/config/settings.conf
|
||||
- **No sensitive data in repo**: .gitignore excludes keys, tokens, credentials
|
||||
- **Test first**: Try on non-production environments first
|
||||
|
||||
## 📊 Recent Updates (v2.2)
|
||||
## 📊 Recent Updates (v2.1)
|
||||
|
||||
### Multi-Control Panel Support (NEW!)
|
||||
### December 2025 - Major Cleanup & Optimization
|
||||
|
||||
#### Launcher Streamlined (NEW!)
|
||||
- ✅ Removed 90+ phantom menu items pointing to non-existent scripts
|
||||
- ✅ Reduced from 1,576 lines to 574 lines (64% reduction)
|
||||
- ✅ Cleaned up 7-level nested menus to 3 levels maximum
|
||||
- ✅ Every menu item now points to a real, working script
|
||||
- ✅ Faster navigation and no more "module not found" errors
|
||||
- ✅ Main menu: 6 categories, 41 total working options
|
||||
|
||||
#### Performance Optimizations
|
||||
- ✅ Bot analyzer now uses cached domain status (eliminates redundant HTTP checks)
|
||||
- ✅ Saves ~5 minutes on 50-domain servers (no more curl requests per check)
|
||||
- ✅ All modules use centralized reference database for domain status
|
||||
- ✅ 1-hour cache prevents wasteful re-checking
|
||||
|
||||
#### MySQL/MariaDB Database Restore Tool
|
||||
- ✅ Advanced database recovery from file-based backups
|
||||
- ✅ Multi-control panel support (cPanel, InterWorx, Plesk, standalone)
|
||||
- ✅ Intelligent Force Recovery with smart detection
|
||||
- ✅ Safe selective restore (single DB from full backup, zero data loss)
|
||||
- ✅ InterWorx path fix (/chroot/home instead of /home symlink)
|
||||
- ✅ SQL output saved to restore directory parent (not control panel dirs)
|
||||
- ✅ Safety features: disk space validation, directory protection, recovery warnings
|
||||
|
||||
#### Documentation Updates
|
||||
- ✅ Main README updated with streamlined menu structure
|
||||
- ✅ New modules/backup/README.md (comprehensive backup tools documentation)
|
||||
- ✅ Updated usage examples to match new launcher
|
||||
- ✅ All recent features documented
|
||||
|
||||
### Multi-Control Panel Support
|
||||
- ✅ Full cPanel support (primary platform - production ready)
|
||||
- ✅ InterWorx support (validated on real servers - production ready)
|
||||
- ✅ Plesk support (validated on real servers - production ready)
|
||||
- ✅ Standalone Apache support (basic functionality)
|
||||
- ✅ 38/38 modules refactored for multi-panel architecture (100% complete)
|
||||
- ✅ Automated validation scripts for InterWorx and Plesk (13 and 15 tests)
|
||||
- ✅ 41 modules refactored for multi-panel architecture
|
||||
- ✅ All critical paths verified on production systems
|
||||
|
||||
### System Detection & Abstraction
|
||||
### Core Features Implemented
|
||||
|
||||
**Security & Monitoring (14 tools)**
|
||||
- Bot & Traffic Analyzer (full + quick scan)
|
||||
- Live Attack Monitor + 3 specialized monitors
|
||||
- IP Reputation Manager
|
||||
- Malware Scanner
|
||||
- 4x Log tail viewers
|
||||
- cPHulk enablement
|
||||
- CT_LIMIT optimization
|
||||
|
||||
**Website Diagnostics (3 tools)**
|
||||
- Website Error Analyzer
|
||||
- Fast 500 Error Tracker
|
||||
- WordPress Tools (WP-Cron manager)
|
||||
|
||||
**Performance Analysis (5 tools)**
|
||||
- MySQL Query Analyzer
|
||||
- Network & Bandwidth Analyzer
|
||||
- Hardware Health Check
|
||||
- PHP Configuration Optimizer
|
||||
- Loadwatch Health Analyzer
|
||||
|
||||
**Backup & Recovery (11 tools)**
|
||||
- Complete Acronis Cyber Protect integration (9 scripts)
|
||||
- MySQL/MariaDB database restore
|
||||
- Cleanup toolkit data
|
||||
|
||||
### System Infrastructure
|
||||
- ✅ Reference database for cross-module intelligence (.sysref with 1-hour cache)
|
||||
- ✅ Automatic control panel detection (system-detect.sh)
|
||||
- ✅ Multi-panel user/domain management abstraction (user-manager.sh)
|
||||
- ✅ Dynamic log discovery for all panel types
|
||||
- ✅ Panel-specific path handling (docroots, logs, configs)
|
||||
- ✅ Multi-panel user/domain management (user-manager.sh)
|
||||
- ✅ Cached domain status checks (eliminates redundant HTTP requests)
|
||||
- ✅ Zero hardcoded paths - all detection-based
|
||||
|
||||
### Backup & Recovery
|
||||
- ✅ Complete Acronis Cyber Protect integration (16 management scripts)
|
||||
- ✅ Agent installation, registration, and update automation
|
||||
- ✅ Comprehensive status monitoring (health, registration, connectivity)
|
||||
- ✅ Manual backup triggering with performance optimizations
|
||||
- ✅ Protection plan management and scheduling
|
||||
- ✅ MySQL/MariaDB database restore tool with intelligent recovery (NEW!)
|
||||
- ✅ Multi-control panel support for database restoration paths
|
||||
- ✅ Smart detection for Force Recovery Level selection
|
||||
- ✅ Safe selective database restore from full backups
|
||||
|
||||
### Website Diagnostics
|
||||
- ✅ Comprehensive website error analyzer (multi-panel)
|
||||
- ✅ 500 error tracking and troubleshooting (multi-panel)
|
||||
- ✅ Multi-log integration (Apache, PHP-FPM, all panels)
|
||||
- ✅ Smart error detection and recommendations
|
||||
|
||||
### Security Enhancements
|
||||
- ✅ Bot analyzer with multi-panel log discovery
|
||||
- ✅ Live attack monitor supporting all control panels
|
||||
- ✅ Malware scanner with panel-aware docroot detection
|
||||
- ✅ Centralized IP reputation tracking
|
||||
- ✅ Real-time threat detection and classification
|
||||
|
||||
### Core Infrastructure
|
||||
- ✅ Modular architecture with organized category structure
|
||||
- ✅ Reference database for cross-module intelligence
|
||||
- ✅ Comprehensive developer documentation (REFDB_FORMAT.txt)
|
||||
- ✅ Production validation complete for all major panels
|
||||
|
||||
## 🙏 Credits
|
||||
|
||||
Built for comprehensive cPanel/Linux server management with a focus on security and intelligent automation.
|
||||
|
||||
Reference in New Issue
Block a user