Skip to content

README.md

Latest commit

 

History

History
352 lines (251 loc) · 6.37 KB

README.md

File metadata and controls

352 lines (251 loc) · 6.37 KB
Raw

IPFS Daemon - Decentralized Storage

Français

InterPlanetary File System (IPFS) daemon for decentralized content-addressed storage.

Features

  • Content-addressed storage: Files identified by cryptographic hash
  • Decentralized: No central servers
  • Peer-to-peer: Direct file sharing between nodes
  • Permanent web: Content can't be deleted if pinned
  • Integration: Works with Emercoin blockchain for naming

Deployment

Docker Run

docker run -d \
  --name ipfs \
  -v ipfs-data:/data/ipfs \
  -p 4001:4001 \
  -p 5001:5001 \
  -p 8080:8080 \
  -p 8081:8081 \
  -e IPFS_STORAGE_MAX=50GB \
  nessnetwork/ipfs

Docker Compose

services:
  ipfs:
    image: nessnetwork/ipfs:latest
    container_name: ipfs
    volumes:
      - ipfs-data:/data/ipfs
    ports:
      - "4001:4001"     # P2P swarm
      - "5001:5001"     # API
      - "8080:8080"     # Gateway
      - "8081:8081"     # WebUI
    environment:
      - IPFS_STORAGE_MAX=50GB
    restart: unless-stopped

volumes:
  ipfs-data:

Ports

  • 4001: P2P swarm (TCP/UDP) - peer connections
  • 5001: HTTP API - programmatic access
  • 8080: Gateway - HTTP access to IPFS content
  • 8081: WebUI - web interface

Usage

Add File to IPFS

# Add file
docker exec ipfs ipfs add /path/to/file

# Returns hash like: QmXxx...

Get File from IPFS

# Get by hash
docker exec ipfs ipfs get QmXxx...

# Or via gateway
curl http://localhost:8080/ipfs/QmXxx...

Pin Content (Keep Forever)

# Pin file
docker exec ipfs ipfs pin add QmXxx...

# List pinned files
docker exec ipfs ipfs pin ls

Node Information

# Node ID and addresses
docker exec ipfs ipfs id

# Connected peers
docker exec ipfs ipfs swarm peers

# Repository stats
docker exec ipfs ipfs repo stat

Integration with Privateness Network

Emercoin + IPFS Naming

# Store IPFS hash in Emercoin blockchain
emercoin-cli name_new "ipfs:myfile" "QmXxx..."

# Resolve via Emercoin
emercoin-cli name_show "ipfs:myfile"
# Returns: QmXxx...

# Access via IPFS
ipfs get QmXxx...

Use Cases

  1. Decentralized website hosting

    • Upload site to IPFS
    • Register hash in Emercoin
    • Access via IPFS gateway

  2. Permanent file storage

    • Upload to IPFS
    • Pin on multiple nodes
    • Content persists as long as at least one node keeps it pinned

  3. Content distribution

    • Upload once
    • Peers distribute automatically
    • Greatly reduced origin bandwidth costs (peers share the load)

  4. Blockchain data storage

    • Store large data in IPFS
    • Store hash in blockchain
    • Verify integrity via hash

Configuration

Storage Limit

# Set max storage (default: 10GB)
docker run -e IPFS_STORAGE_MAX=50GB nessnetwork/ipfs

Garbage Collection

Automatic garbage collection runs every hour to remove unpinned content.

# Manual garbage collection
docker exec ipfs ipfs repo gc

Bootstrap Nodes

IPFS connects to default bootstrap nodes. To add custom nodes:

# Add bootstrap node
docker exec ipfs ipfs bootstrap add /ip4/1.2.3.4/tcp/4001/p2p/QmXxx...

# List bootstrap nodes
docker exec ipfs ipfs bootstrap list

WebUI

Access IPFS WebUI at: http://localhost:8081/webui

Features:

  • File browser
  • Peer connections
  • Repository stats
  • Settings

API Examples

Python

import requests

# Add file
files = {'file': open('myfile.txt', 'rb')}
response = requests.post('http://localhost:5001/api/v0/add', files=files)
hash = response.json()['Hash']

# Get file
response = requests.post(f'http://localhost:5001/api/v0/cat?arg={hash}')
content = response.content

JavaScript

const ipfsClient = require('ipfs-http-client');
const ipfs = ipfsClient.create({ url: 'http://localhost:5001' });

// Add file
const { cid } = await ipfs.add('Hello IPFS!');
console.log('Hash:', cid.toString());

// Get file
const chunks = [];
for await (const chunk of ipfs.cat(cid)) {
    chunks.push(chunk);
}
console.log('Content:', Buffer.concat(chunks).toString());

Bash

# Add file
curl -F file=@myfile.txt http://localhost:5001/api/v0/add

# Get file
curl "http://localhost:5001/api/v0/cat?arg=QmXxx..."

Monitoring

Check Health

# Daemon status
docker exec ipfs ipfs id

# Peer count
docker exec ipfs ipfs swarm peers | wc -l

# Storage usage
docker exec ipfs ipfs repo stat

Logs

# View logs
docker logs ipfs

# Follow logs
docker logs -f ipfs

Security

Private Network (Optional)

To create a private IPFS network:

# Generate swarm key
docker exec ipfs ipfs-swarm-key-gen > swarm.key

# Copy to all nodes
docker cp swarm.key ipfs:/data/ipfs/swarm.key

# Restart daemon
docker restart ipfs

API Access Control

By default, API is only accessible from localhost. To restrict further:

# Set API to localhost only
docker exec ipfs ipfs config Addresses.API /ip4/127.0.0.1/tcp/5001

Backup

Export Repository

# Backup IPFS data
docker run --rm -v ipfs-data:/data -v $(pwd):/backup \
  alpine tar czf /backup/ipfs-backup.tar.gz /data

Restore Repository

# Restore IPFS data
docker run --rm -v ipfs-data:/data -v $(pwd):/backup \
  alpine tar xzf /backup/ipfs-backup.tar.gz -C /

Performance Tuning

Increase Connections

# Allow more peer connections
docker exec ipfs ipfs config --json Swarm.ConnMgr.HighWater 900
docker exec ipfs ipfs config --json Swarm.ConnMgr.LowWater 600

Enable Experimental Features

# QUIC transport (faster)
docker exec ipfs ipfs config --json Experimental.QUIC true

# Accelerated DHT
docker exec ipfs ipfs config --json Experimental.AcceleratedDHTClient true

Troubleshooting

Can't Connect to Peers

# Check firewall allows port 4001
# Check NAT/port forwarding

# Test connectivity
docker exec ipfs ipfs swarm peers

High Storage Usage

# Run garbage collection
docker exec ipfs ipfs repo gc

# Reduce storage limit
docker exec ipfs ipfs config Datastore.StorageMax 10GB

Slow Performance

# Check peer count (should be > 10)
docker exec ipfs ipfs swarm peers | wc -l

# Add more bootstrap nodes
docker exec ipfs ipfs bootstrap add <peer-address>

Resources