Welcome to the Swarm documentation!

Contents:

• Introduction
  • Basics
  • About
    • This document
    • Status
    • License
    • Credits
    • Community
    • Reporting a bug and contributing
    • Roadmap and Resources
• Installation and Updates
  • Installing Swarm binaries
  • Installing Swarm from source
    • Prerequisites
      • Ubuntu
      • Generic linux
    • Compiling and installing
    • Updating your client
• Getting started
  • How do I connect to Swarm?
    • Verifying that your local Swarm node is up
  • How do I enable ENS name resolution?
    • Using Swarm together with the testnet ENS
  • Alternative Networks
    • Swarm in singleton mode (no peers)
    • Adding enodes manually
    • Running a private swarm
• Uploading and Downloading
  • Introduction
  • Using CLI
    • Uploading a file to your local Swarm node
      • Suppressing automatic manifest creation
    • Downloading a single file
    • Uploading to a remote Swarm node
    • Uploading a directory
      • Directory with default entry
    • Downloading a directory
    • Adding entries to a manifest
  • Using HTTP
    • 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
• Using ENS names
• Encryption
• BZZ URL schemes
  • bzz
  • bzz-raw
  • bzz-list
  • bzz-hash
  • bzz-immutable
  • bzz-resource
• Configuration
  • Command line options for swarm
  • Config File
  • General configuration parameters
• Manifests
  • Manifests in Swarm
    • Path Matching
• PSS
  • Configuration
  • Sending a message
  • Sending a raw message
  • Advanced features
    • Handshakes
    • Protocols
• Mutable Resource Updates
  • Creating a mutable resource
  • Retrieving a mutable resource
  • Mutable resource versioning
  • Retrieving a specific mutable resource version
• FUSE
  • Installing FUSE
  • CLI Usage
    • Mount
    • Unmount
    • List Mounts
• API Reference
  • HTTP
  • JavaScript
    • swarm-js
    • swarmgw
  • RPC
    • FUSE
    • PSS
• Architecture
  • Overlay network
    • Logarithmic distance
    • Kademlia topology
    • Bootstrapping and discovery
  • Distributed preimage archive
    • Redundancy
    • Caching and purging Storage
    • Syncronisation
  • Data layer
  • Swarm hash
  • Chunker
  • 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
• Resources
  • Orange Papers
  • Videos

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