Welcome to the Auto Cleanup Script documentation. This script is designed to help you automatically clean up specified files within home directories on your server, specifically cPanel/WHM Servers, making it easier to manage and maintain your hosting environment. In this documentation, we will guide you through the installation process, customization options, and important notes to ensure smooth operation.

The Auto Cleanup Script offers the following key features:

• Automated Cleanup: The script automatically locates and deletes specified file types within home directories.
• Customization: You can customize the types of files to be deleted to suit your specific requirements.
• Scheduled Cleanup: The script is configured to run on a predefined schedule, ensuring regular and hassle-free cleanup.
• Flexibility: You can modify the cron job schedule or add new file types as needed.

Whether you're a hosting provider or an individual managing your server, the Auto Cleanup Script can help keep your server clean and efficient.

Installation Prerequisites

Before setting up the Auto Cleanup Script, please make sure to complete the following prerequisites:

1. Install dos2unix: Ensure that the 'dos2unix' utility is installed on your server. This utility is required to convert script files to Unix format and make them executable. Otherwise, script won't execute.
• For CentOS/RHEL:

yum install dos2unix -y

• For Ubuntu/Debian:

apt-get install dos2unix

Default Settings

The Auto Cleanup Script comes with a set of default file types that are scheduled for deletion within home directories. These default file types include:

• *.tar.gz: Tarball archives.
• *.wpress: WordPress backup files.
• error_log: Error log files.

By default, the Auto Cleanup Script is configured to run every Sunday at 3 AM. This ensures regular cleanup of the specified file types within home directories.

Customization

Before running the script, you can customize the types of files the script deletes within home directories. The script comes with a default set of file types, but you can add, delete, or update them to match your requirements. To customize the script:

1. Open the Cleanup Script:

nano /root/auto_cleanup_script.sh

2. Customize File Types: Locate the section in the script that defines the file types to be deleted. The section looks like this:

# Define the file types you want to delete
file_types=("*.tar.gz" "*.wpress" "error_log")

3. Add, Delete, or Update File Types: You can perform the following actions:
• Add File Types: To add a new file type for deletion, insert it into the array within double quotes and separate multiple file types with spaces. For example, to add ".log" files and ".zip" files:

file_types=("*.log" "*.zip")

• Delete File Types: To remove a file type from deletion, simply remove it from the array. For example, to stop deleting ".wpress" files:

file_types=("*.tar.gz" "error_log")

• Update File Types: To update a file type, modify its entry in the array. For example, to change ".tar.gz" to ".backup" files:

file_types=("*.backup" "*.wpress" "error_log")

4. Save the script after making your customizations.

By customizing the file types, you can tailor the script to clean up specific types of files in your home directories.

Changing Cron Job Frequency

If you want to change the frequency at which the cleanup script runs automatically, follow these steps:

1. Edit the Cron Tab:

crontab -e

2. Modify the Cron Job Line: Locate the line that corresponds to the cleanup script. Modify this line to specify the desired schedule. For example, to run the script every day at 2 AM, use:

0 2 * * * /root/auto_cleanup_script.sh

3. Save the changes and exit the text editor.

Force Execution

If you need to force the execution of the Auto Cleanup Script outside of its scheduled time (e.g., for immediate cleanup), you can do so manually. To force execution:

1. Open your terminal or SSH into your server.
2. Navigate to the location of the Auto Cleanup Script:

cd /root

3. Run the script:

./auto_cleanup_script.sh

• Note: It is highly recommended to run this script using the screen utility for uninterrupted execution.

Running the script manually will trigger an immediate cleanup, regardless of the scheduled time. Use this option with caution and only when necessary.

Important Notes

• Always ensure you have backups of important data before running the script or making changes.
• Review and test any changes to the cron job schedule to ensure they meet your requirements and do not disrupt your server's operation.
• Regular Backups: It's crucial to maintain regular backups of critical data. While this script aids in cleanup, having backups is essential for data recovery in case of accidental deletions.
• Script Testing: We recommend testing the script in a non-production environment first to ensure it behaves as expected and doesn't inadvertently delete important files.
• Script Updates: Keep an eye out for script updates or improvements in the future. You can find these updates and instructions on how to apply them [here].
• User Responsibility: You are responsible for any modifications or customizations you make to the script. Please follow best practices and ensure your changes align with your server's needs.
• Security: This script should only be used on servers where it's necessary, and we advise against running scripts from untrusted sources.
• Documentation: For comprehensive documentation and advanced customization options, refer to this page only.