Add README.md

README.md

@@ -0,0 +1,95 @@
+# CloudPanel GoAccess Analytics Automation
+
+Automated GoAccess analytics setup script for CloudPanel users. Generate privacy-focused website analytics without external dependencies.
+
+## Features
+
+- 🚀 One-click GoAccess installation and configuration
+- 📊 Automatic analytics report generation for all domains
+- 🔄 Auto-updates reports every 5 minutes
+- 📁 Intelligent log rotation management
+- 🔒 Privacy-focused with no external tracking
+- 👥 Multi-user and multi-domain support
+- 🛡️ Secure permissions handling
+- 🔧 Non-destructive configuration updates
+
+## Prerequisites
+
+- CloudPanel installation
+- Root/sudo access
+- Nginx web server
+- Bash shell
+
+## Quick Start
+
+1. Clone the repository:
+```bash
+git clone https://github.com/yourusername/cloudpanel-goaccess.git
+```
+
+2. Make the script executable:
+```bash
+chmod +x goaccess-setup.sh
+```
+
+3. Run the script:
+```bash
+sudo ./goaccess-setup.sh
+```
+
+## Access Your Analytics
+
+Find your analytics reports at:
+```
+/home/your-username/htdocs/your-domain/insights/goaccess.html
+```
+
+## How It Works
+
+The script:
+1. Installs and configures GoAccess
+2. Sets up log rotation rules
+3. Creates domain-specific insights directories
+4. Configures automatic report generation
+5. Sets up proper permissions
+6. Establishes periodic updates via cron
+
+## Configuration
+
+The script automatically configures:
+- Log rotation policies
+- Report generation intervals
+- File permissions
+- User-specific settings
+
+No manual configuration required!
+
+## Troubleshooting
+
+Check the logs:
+```bash
+tail -f /var/log/goaccess_cron.log
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create a Pull Request
+
+## License
+
+This project is licensed under the GNU GPL License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- GoAccess team for their excellent analytics tool
+- CloudPanel community for inspiration and testing
+
+## Support
+
+- 📝 [Full Blog Post](https://forum.hhf.technology/t/automated-website-analytics-with-goaccess-a-complete-guide-for-cloudpanel-users)
+- 🐛 [Issue Tracker](https://forum.hhf.technology/t/automated-website-analytics-with-goaccess-a-complete-guide-for-cloudpanel-users)
+- 📘 [Documentation](https://forum.hhf.technology/t/automated-website-analytics-with-goaccess-a-complete-guide-for-cloudpanel-users)