Welcome to the swarm documentation!

Contents:

• Introduction
  • Background
  • Basics
  • About
    • This document
    • Status
    • License
    • Credits
    • Community
    • Reporting a bug and contributing
    • Roadmap and Resources
• Installation and Updates
  • Installation
  • Supported Platforms
  • Prerequisites
  • Ubuntu
  • Installing from source
  • Updating your client
• Connecting to Swarm (Simple)
  • How do I connect?
  • How do I upload and download?
    • Tar stream upload
    • Multipart form upload
    • Files can also be added to an existing manifest:
    • Files can also be uploaded using a simple HTML form:
    • Listing files
• Connecting to Swarm (Advanced)
  • Preparation
  • Connecting to the swarm testnet
    • Connecting swarm only (no blockchain)
    • Using swarm together with the Ropsten testnet blockchain
    • Adding enodes manually
  • Swarm in singleton mode
  • Running a private swarm
  • Testing SWAP
    • Testing SWAP on your private blockchain.
      • Custom genesis block
      • Mining on your private chain
  • Configuration
  • Command line options for swarm
  • Configuration options
    • General configuration parameters
    • Storage parameters
    • Chunker parameters
    • Hive parameters
    • Kademlia parameters
    • SWAP profile parameters
    • SWAP strategy parameters
    • SWAP pay profile parameters
    • Synchronisation parameters
    • Setting up SWAP
• Usage
  • Using swarm from the command line
    • Uploading a file or directory to swarm
      • Example: uploading a file
      • Example: Uploading a directory
  • Content retrieval: hashes and manifests
    • Retrieving content using the http proxy
    • bzz url schemes
      • bzz
      • bzz-immutable
      • bzz-raw
      • bzz-list
      • bzz-hash
      • bzzr and bzzi
    • Manifests
    • Path Matching on Manifests
  • Ethereum Name Service
    • Content Retrieval using ENS
    • Registering names for your swarm content
      • Preparation
      • Registering a .test domain
      • Registering a .eth domain
      • Setting up a resolver
      • Registering a swarm hash on the publicResolver
      • Looking up names in the ENS manually
      • Updating your content
  • The HTTP API
  • Swarm IPC API
    • Mounting Swarm
      • Installing FUSE
    • Chequebook RPC API
    • Example: use of the console
      • Uploading content
      • Downloading content
• Architecture
  • Swarm hash
    • Introduction
    • Description
    • Strict interpretation
    • Loose interpretations
  • Chunker
  • Distributed Preimage Archive
    • High-level design
    • Requests
  • Syncing
  • Peer management (hive, kademlia)
    • Peer addresses
    • Logarithmic distance and network topology
    • Peer table format
    • Peer table update
  • The bzz protocol
  • Incentivisation
    • swap, swear & swindle
    • SWAP – Swarm Accounting Protocol
    • SWEAR – Storage With Enforced Archiving Rules or Swarm Enforcement And Registration
    • SWINDLE – Secured With INsurance Deposit Litigation and Escrow

This document is licensed under the @emph{Creative Commons Attribution License}. To view a copy of this license, visit http://creativecommons.org/licenses/by/2.0/

Indices and tables

• Index
• Module Index
• Search Page