diff --git a/README.md b/README.md index 57c7b32..1acef84 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,153 @@ -# cyberchef_ngx_cloudpanel +# Docker Installation Scripts for CloudPanel +A collection of installation scripts for deploying various Docker applications with CloudPanel integration. These scripts provide automated installation, configuration, and troubleshooting for popular self-hosted applications. + +## 🚀 Features + +- Automated Docker and application installation +- CloudPanel integration support +- Robust error handling and logging +- Port conflict detection +- Automatic service health checks +- Backup and restore functionality +- Comprehensive troubleshooting guides + +## 📋 Available Scripts + +### CyberChef Installation Script +- Web-based cyber security toolkit deployment +- Single container setup +- Port availability verification +- Health monitoring +- CloudPanel reverse proxy support + +## 🔧 Prerequisites + +- Ubuntu 24.04 ONLY +- Root access or sudo privileges +- CloudPanel pre-installed +- Domain/subdomain pointing to your server + +## 📥 Installation + +1. Download this script: +```bash +wget https://git.hhf.technology/hhf/cyberchef_ngx_cloudpanel/raw/branch/main/install-cyberchef.sh + +``` + +2. Make scripts executable: +```bash +chmod +x install-cyberchef.sh +``` + +3. Run desired installation script: +```bash +sudo ./install-cyberchef.sh +``` + +## 🛠️ Usage Examples + + +### Installing CyberChef: +```bash +sudo ./install-cyberchef.sh +# Configure CloudPanel reverse proxy after installation +``` + +## ⚙️ Configuration + +Each script includes the following configurable elements: + +### CyberChef Script +- Port settings +- Network configuration +- Volume mappings + +## 🔍 Troubleshooting + +### Common Issues and Solutions + +1. Port Conflicts: +```bash +# Check for port usage +sudo lsof -i :port_number +# Kill conflicting process +sudo kill process_id +``` + +2. Container Health Check Failures: +```bash +# View container logs +docker compose logs service_name +# Restart service +docker compose restart service_name +``` + +3. Permission Issues: +```bash +# Fix volume permissions +sudo chown -R 1000:1000 /path/to/volume +``` + +## 🔒 Security Recommendations + +1. Always use HTTPS with valid SSL certificates +2. Regularly update Docker and containers +3. Implement proper firewall rules +4. Use strong passwords for services +5. Regular backup of important data + +## 📝 Logging + +Logs are stored in the following locations: + +- Docker: `/var/log/docker.log` +- CyberChef: `/var/log/cyberchef-install.log` + +## 🔄 Updates + +To update installed applications: + +```bash +cd /docker/application_name +docker compose pull +docker compose up -d +``` + +## 💾 Backup and Restore + +### Backup: +```bash +# For any application +cd /docker +tar -czf application_backup.tar.gz application_name/ +``` + +### Restore: +```bash +cd /docker +tar -xzf application_backup.tar.gz +cd application_name +docker compose up -d +``` + +## 📄 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## 🙏 Acknowledgments + +* CloudPanel team for their excellent platform +* Docker community for container solutions +* Original application developers (CyberChef) + +## 📞 Support + +For support: +1. Check the troubleshooting guides +2. Review the application logs +3. [Join our community discussions](https://forum.hhf.technology/t/installing-cyberchef-with-cloudpanel-a-complete-guide-2025-ubuntu-24-04-only/456) + +--- +⌨️ with ❤️ by HHF Technology