Implement experimental IPFS cleaner

[nesitor]

IPFS Pin Cleaner: Experimental Method

This document outlines the procedure for executing the experimental IPFS pin cleaner script, which reclaims disk space by removing unused pins from the InterPlanetary File System (IPFS) repository.

---

Preparation

Before executing the script, ensure you are in the same directory as your docker-compose.yml file. This is crucial for the script to correctly interact with your IPFS instance. You will also need to get the database user and password from your docker-compose.yml file as they are required for the cleanup script to run.

---

Execution and Performance

The script's execution time is typically less than 10 minutes but can vary based on several factors:

• Data Volume: The amount of data to be cleaned directly impacts the duration.
• Hardware Resources: Performance depends on the underlying hardware, including disk speed, available RAM, and CPU.

---

Cautionary Note

WARNING: Executing this procedure will temporarily halt the CCN software. This interruption is necessary for the cleaning process to function correctly. Depending on the hardware resources of the machine, this may lead to:

• Service Downtime: Services relying on the CCN software will be unavailable during the cleanup.
• Score Reduction: The node's score may be negatively affected.

---

Command-Line Procedure

Execute the following commands in the terminal to download and run the script:

1. Download the script: Use wget to retrieve the run_ipfs_cleanup.sh script from the specified GitHub repository.

   wget https://raw.githubusercontent.com/aleph-im/pyaleph/refs/heads/andres-feature-implement_experimental_ipfs_pin_cleaner/deployment/scripts/run_ipfs_cleanup.sh

2. Grant execution permissions: Use chmod to make the script executable.

   chmod +x run_ipfs_cleanup.sh

3. Execute the script: Run the script with superuser privileges using sudo.

   sudo ./run_ipfs_cleanup.sh