Skip to content

Latest commit

Β 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

README.md

πŸ“š CyberPanel Mods Documentation

Welcome to the comprehensive documentation for CyberPanel Mods. This documentation provides detailed guides, troubleshooting information, and best practices for using the enhanced CyberPanel mods repository.

Note: The main README.md has been reorganized to be a high-level overview. All detailed commands and usage instructions are now in this guides folder. See README_REORGANIZATION.md for details.

πŸ“– Documentation Index

πŸš€ Getting Started

πŸ”§ User Guides

πŸ›‘οΈ Security

πŸ–₯️ Operating Systems

πŸ” Troubleshooting

πŸ“¦ Advanced Topics

🀝 Contributing

πŸš€ Quick Start

1. Check Compatibility

curl -sSL https://raw.githubusercontent.com/master3395/cyberpanel-mods/main/utilities/os_compatibility_checker.sh | bash

2. Install Enhanced Utility

curl -sSL https://raw.githubusercontent.com/master3395/cyberpanel-mods/main/utilities/cyberpanel_utility_enhanced.sh | bash

3. Run Core Fixes

curl -sSL https://raw.githubusercontent.com/master3395/cyberpanel-mods/main/core-fixes/cyberpanel_core_fixes_enhanced.sh | bash

4. Apply Security Hardening

curl -sSL https://raw.githubusercontent.com/master3395/cyberpanel-mods/main/security/cyberpanel_security_enhanced.sh | bash

πŸ“‹ Complete Repository Structure

πŸ“ Script Categories

πŸ”§ Core Fixes (core-fixes/)

  • cyberpanel_core_fixes_enhanced.sh - Comprehensive core fixes
  • cyberpanel_fix_symbolic_links.sh - Fix symbolic links
  • fix_503_service_unavailable.sh - Fix 503 errors
  • fix_missing_wp_cli.sh - Install WP-CLI
  • fixperms.sh - Fix file permissions

πŸ”„ Version Managers (version-managers/)

  • php_version_manager_enhanced.sh - Enhanced PHP version manager
  • phpmod.sh - Original PHP version changer
  • phpmod_v2.sh - PHP version changer v2
  • mariadb_version_manager_enhanced.sh - Enhanced MariaDB version manager
  • mariadb_v_changer.sh - Original MariaDB version changer
  • snappymail_v_changer.sh - Snappymail version changer
  • phpmyadmin_v_changer.sh - phpMyAdmin version changer
  • modsec_rules_v_changer.sh - ModSecurity rules changer

πŸ›‘οΈ Security (security/)

  • cyberpanel_security_enhanced.sh - Comprehensive security hardening
  • disable_2fa.sh - Disable two-factor authentication
  • fix_permissions.sh - Fix file permissions
  • fix_ssl_missing_context.sh - Fix SSL context issues
  • reset_ols_adminpassword - Reset OpenLiteSpeed admin password
  • selfsigned_fixer.sh - Fix self-signed certificates
  • cp_permissions.txt - CyberPanel permissions reference

πŸ› οΈ Utilities (utilities/)

  • cyberpanel_utility_enhanced.sh - Enhanced CyberPanel utility
  • cyberpanel_utility.sh - Original CyberPanel utility
  • os_compatibility_checker.sh - OS compatibility checker
  • cloudflare_to_powerdns.sh - DNS migration tool
  • crowdsec_update.sh - CrowdSec updater
  • cyberpanel_sessions_cronjob.sh - Sessions cleanup cronjob
  • cyberpanel_sessions.sh - Sessions cleanup script
  • defaultwebsitepage.html - Default website page template
  • defaultwebsitepage.sh - Default website page installer
  • install_pureftpd.sh - PureFTPd installer
  • install_vsftpd.sh - vsftpd installer
  • loader-wizard.php - Loader wizard
  • lsmcd - LiteSpeed Memcached
  • wp - WordPress CLI wrapper

πŸ’Ύ Backup & Restore (backup-restore/)

  • cyberpanel.sql - CyberPanel database schema
  • rclone_backup_cronjob.sh - RClone backup cronjob
  • rclone_sqlbackup_cronjob.sh - SQL backup cronjob
  • restore_cyberpanel_database.sh - Database restore script

πŸ–₯️ OS-Specific (os-specific/)

  • cyberpanel_almalinux9_upgrade_fix.sh - AlmaLinux 9 upgrade fix
  • installCyberPanel_almalinux9_patch.py - AlmaLinux 9 patch

πŸ“ Documentation Structure

πŸ“š Core Documentation

  • Installation Guide - Step-by-step installation instructions
  • Troubleshooting Guide - Common issues and solutions
  • Security Best Practices - Comprehensive security guide
  • OS-Specific Notes - Operating system compatibility details
  • Menu Demo - Master menu demonstration guide

πŸ“š User Guides

  • Core Fixes Guide - Using core fixes and repairs
  • Version Management - Managing software versions
  • Security Hardening - Security configuration
  • Backup and Restore - Backup procedures

πŸ“š Advanced Topics

  • Custom Scripts - Creating custom mods
  • API Integration - External API integration
  • Monitoring Setup - Monitoring configuration
  • Disaster Recovery - Recovery procedures

πŸ” Finding Information

By Category

  • Installation - Setup and installation guides
  • Configuration - System configuration guides
  • Security - Security-related documentation
  • Troubleshooting - Problem-solving guides
  • Advanced - Advanced topics and customization

By Operating System

  • Ubuntu - Ubuntu-specific guides
  • RHEL-based - AlmaLinux, RockyLinux, RHEL guides
  • CloudLinux - CloudLinux-specific guides
  • Debian - Debian-specific guides

By Task

  • Getting Started - Initial setup and configuration
  • Daily Operations - Routine maintenance tasks
  • Problem Solving - Troubleshooting and fixes
  • Optimization - Performance tuning and optimization

πŸ“š Reading Recommendations

For New Users

  1. Start with the Installation Guide
  2. Read the Quick Start guide
  3. Review Security Best Practices
  4. Keep the Troubleshooting Guide handy

For Experienced Users

  1. Check OS-Specific Notes for your system
  2. Review Advanced Topics for customization
  3. Read Contributing Guide to contribute
  4. Explore Custom Scripts for automation

For System Administrators

  1. Study Security Best Practices thoroughly
  2. Review Monitoring Setup for production
  3. Read Disaster Recovery procedures
  4. Check Performance Tuning for optimization

πŸ”„ Keeping Documentation Updated

Documentation Updates

Contributing to Documentation

πŸ“ž Getting Help

Documentation Issues

Technical Support

πŸ“Š Documentation Statistics

Coverage

  • Operating Systems: 12+ supported systems
  • Scripts: 50+ enhanced scripts
  • Guides: 20+ comprehensive guides
  • Languages: English (primary)

Quality

  • Accuracy: Regularly tested and updated
  • Completeness: Comprehensive coverage of all features
  • Clarity: Clear, step-by-step instructions
  • Examples: Practical examples and use cases

πŸ”— External Resources

Official Documentation

Community Resources

Security Resources

  • OWASP - Web application security
  • CVE - Common vulnerabilities
  • NIST - Security standards

Need help? Check our Troubleshooting Guide or open an issue for assistance.