Internet Utilities

xsukax IPFS Tools

xsukax

xsukax IPFS Tools

A lightweight, privacy-focused web application for accessing and analyzing IPFS (InterPlanetary File System) content through multiple gateways and specialized tools.

Live Demo: https://xsukax.github.io/xsukax-IPFS-Tools

Github Repo: https://github.com/xsukax/xsukax-IPFS-Tools

Project Overview

xsukax IPFS Tools is a client-side web application designed to simplify interaction with IPFS content by providing instant access to multiple IPFS gateways, CID analysis tools, and specialized content viewers. The application operates entirely in the browser, requiring no backend infrastructure, which ensures maximum privacy and eliminates potential points of data collection or surveillance.

Users can enter any valid Content Identifier (CID) and instantly generate links to access that content through 12+ trusted IPFS gateways, analyze the CID structure using specialized inspection tools, or view video content through dedicated IPFS video players. The tool is particularly valuable for content creators, developers, and users who need reliable access to decentralized content across multiple gateway providers.

Security and Privacy Benefits

This application implements a privacy-first architecture that prioritizes user security and data protection:

  • Zero Server-Side Processing: All operations execute entirely within the user’s browser using client-side JavaScript, ensuring no CID data or user queries are transmitted to external servers for processing
  • No Data Collection: The application does not collect, store, or transmit any user data, search queries, or CID information to analytics services or third-party trackers
  • No External Dependencies: The application is self-contained in a single HTML file with no external JavaScript libraries, frameworks, or API calls that could compromise privacy
  • Client-Side URL Management: Browser history and URL parameters are managed locally without server interaction, allowing users to bookmark and share CID links without privacy concerns
  • Open Source Transparency: The entire application source code is available for audit, enabling security researchers and users to verify privacy claims
  • No Authentication Required: Users can access all functionality without creating accounts, providing personal information, or authenticating through third-party services
  • Gateway Diversity: By providing access to multiple independent IPFS gateways, the application reduces dependency on any single service provider and mitigates censorship risks

Features and Advantages

  • Multi-Gateway Access: Instant link generation for 12+ trusted IPFS gateways including Cloudflare, Pinata, NFT.Storage, and Web3.Storage
  • CID Analysis Tools: Direct access to CID Inspector and IPLD Explorer for detailed content identifier analysis
  • Specialized Viewers: Dedicated IPFS video player integration for media content
  • Responsive Design: Modern, mobile-friendly interface optimized for all device sizes
  • Zero Installation: Works immediately in any modern web browser without plugins or extensions
  • Offline Capable: Can be downloaded and run locally without internet connectivity (after initial download)
  • Fast Performance: Lightweight single-file architecture ensures instant loading and minimal resource usage
  • URL Parameter Support: Direct linking to specific CIDs via URL parameters for easy sharing
  • Browser History Integration: Seamless navigation with back/forward button support
  • Accessibility: Clean, semantic HTML with proper ARIA attributes for screen reader compatibility

Installation Instructions

Option 1: GitHub Pages (Recommended for End Users)

Simply visit the live demo at https://xsukax.github.io/xsukax-IPFS-Tools – no installation required.

Option 2: Local Installation

  1. Clone the repository:

    git clone https://github.com/xsukax/xsukax-IPFS-Tools.git
cd xsukax-IPFS-Tools

  2. Open index.html in your web browser:

    
# On Linux/macOS
open index.html

On Windows

start index.html

Or simply double-click index.html in your file explorer


### Option 3: Web Server Deployment

Deploy to any static web hosting service:

```bash
# Example using Python's built-in server for local testing
python3 -m http.server 8000
# Then visit http://localhost:8000 in your browser

Option 4: Self-Hosting with Apache/Nginx

  1. Copy index.html to your web server’s document root
  2. Ensure proper MIME types are configured (no special configuration needed for standard HTML)
  3. Access via your domain or server IP

PHP Configuration (php.ini)

This application does not require PHP as it is a pure client-side HTML/JavaScript application. No php.ini configuration is necessary. The application can be served by any web server capable of delivering static HTML files, including Apache, Nginx, or even file-based hosting services.

Usage Guide

Step-by-Step Instructions

  1. Access the Application

    • Navigate to the live demo or your local installation
    • The home page displays an input field for CID entry

  2. Enter a CID

    • Paste or type a valid IPFS Content Identifier (CID) into the input field
    • Example CID: QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG

  3. Explore Content

    • Click the “Explore CID” button or press Enter
    • The application generates categorized links for:
      • IPFS Gateways: Access your content through multiple providers
      • CID Analysis: Inspect the structure and properties of your CID
      • Video Viewer: Stream video content if applicable

  4. Access Content

    • Click any gateway link to open the content in a new browser tab
    • Each gateway provides an independent path to the same content
    • If one gateway is slow or unavailable, try another

  5. Analyze CIDs

    • Use CID Inspector to view detailed information about content structure
    • Use IPLD Explorer to navigate linked data structures

  6. Share Links

    • Copy the URL from your browser’s address bar to share your results
    • The URL includes the CID parameter for direct access: ?cid=YOUR_CID_HERE

  7. Return Home

    • Click the “← Back to Home” button to enter a new CID
    • Use browser back/forward buttons for navigation history

Advanced Usage

Direct CID Access via URL:

https://xsukax.github.io/xsukax-IPFS-Tools?cid=QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG

Bookmarking Frequently Used CIDs: Save result pages as bookmarks for quick access to specific content across all gateways.

Keyboard Shortcuts:

  • Press Enter in the input field to submit
  • Use browser’s Ctrl+L (Cmd+L on Mac) to focus address bar for URL sharing

Licensing Information

This project is licensed under the GNU General Public License v3.0.

Contributing

Contributions are welcome! Please feel free to submit pull requests, report issues, or suggest new features on the GitHub repository.

Support

If you find this tool useful, consider supporting development through the cryptocurrency addresses provided within the application interface.

Acknowledgments

This project leverages the decentralized IPFS network and publicly available gateway infrastructure provided by the IPFS community and various organizations committed to distributed web technologies.

Leave a Reply

Your email address will not be published. Required fields are marked *