Welcome to the Swarm documentation!

Swarm is a distributed storage platform and content distribution network, a native base layer service of the Ethereum web3 stack.

This documentation was created with curious end-users, third web enterpreneurs and developers in mind. It should make you thoroughly educated about Swarm within a reasonable amount of time.

Table of contents:

• 1. Introduction
  • 1.1. Objective
  • 1.2. Overview
  • 1.3. Available APIs
  • 1.4. Code
  • 1.5. Roadmap
  • 1.6. Public gateways
  • 1.7. Example Dapps
  • 1.8. Reporting a bug and contributing
  • 1.9. Credits
    • 1.9.1. The Core team
    • 1.9.2. Sponsors and collaborators
    • 1.9.3. Special thanks
• 2. Installation and Updates
  • 2.1. Installing Swarm on Ubuntu via PPA
  • 2.2. Installing Swarm from source
    • 2.2.1. Prerequisites
    • 2.2.2. Configuration
    • 2.2.3. Compiling and installing
    • 2.2.4. Updating your client
• 3. Getting started
  • 3.1. Running Swarm
    • 3.1.1. Verifying that your local Swarm node is running
  • 3.2. How do I enable ENS name resolution?
    • 3.2.1. Using Swarm together with the testnet ENS
    • 3.2.2. Using an external ENS source
  • 3.3. Alternative modes
    • 3.3.1. Swarm in singleton mode (no peers)
    • 3.3.2. Adding enodes manually
    • 3.3.3. Connecting to the public Swarm cluster
• 4. Uploading and downloading
  • 4.1. Introduction
  • 4.2. Using CLI
    • 4.2.1. Uploading a file to your local Swarm node
    • 4.2.2. Downloading a single file
    • 4.2.3. Uploading to a remote Swarm node
    • 4.2.4. Uploading a directory
    • 4.2.5. Downloading a directory
    • 4.2.6. Adding entries to a manifest
  • 4.3. Using HTTP
    • 4.3.1. Tar stream upload
    • 4.3.2. Multipart form upload
    • 4.3.3. Add files to an existing manifest using multipart form
    • 4.3.4. Upload files using a simple HTML form
    • 4.3.5. Listing files
• 5. Working with content
  • 5.1. Using ENS names
    • 5.1.1. Overview of ENS (video)
  • 5.2. Feeds
    • 5.2.1. Feed Manifests
    • 5.2.2. Feeds API
    • 5.2.3. Computing Feed Signatures
  • 5.3. Manifests
  • 5.4. Encryption
  • 5.5. Access Control
    • 5.5.1. Password protection
    • 5.5.2. Selective access using EC keys
    • 5.5.3. Usage
    • 5.5.4. CLI usage
    • 5.5.5. HTTP usage
  • 5.6. FUSE
    • 5.6.1. Installing FUSE
    • 5.6.2. CLI Usage
  • 5.7. BZZ URL schemes
    • 5.7.1. bzz
    • 5.7.2. bzz-raw
    • 5.7.3. bzz-list
    • 5.7.4. bzz-hash
    • 5.7.5. bzz-immutable
    • 5.7.6. bzz-resource
• 6. PSS
  • 6.1. Basics
    • 6.1.1. Privacy features
  • 6.2. Usage
    • 6.2.1. Registering a recipient
    • 6.2.2. Sending a message
    • 6.2.3. Sending a raw message
    • 6.2.4. Receiving messages
  • 6.3. Advanced features
    • 6.3.1. Handshakes
    • 6.3.2. Protocols
• 7. API reference
  • 7.1. HTTP
  • 7.2. JavaScript
    • 7.2.1. erebos
    • 7.2.2. swarm-js
    • 7.2.3. swarmgw
  • 7.3. RPC
    • 7.3.1. FUSE
    • 7.3.2. PSS
• 8. Configuration
  • 8.1. Command line options for swarm
  • 8.2. Config File
  • 8.3. General configuration parameters
• 9. Architecture
  • 9.1. Preface
  • 9.2. Overlay network
    • 9.2.1. Logarithmic distance
    • 9.2.2. Kademlia topology
    • 9.2.3. Bootstrapping and discovery
  • 9.3. Distributed preimage archive
    • 9.3.1. Redundancy
    • 9.3.2. Caching and purging Storage
    • 9.3.3. Synchronisation
  • 9.4. Data layer
    • 9.4.1. Files
    • 9.4.2. Manifests
  • 9.5. Components
    • 9.5.1. Swarm Hash
    • 9.5.2. Chunker
    • 9.5.3. Web3 services
• 10. Resources
  • 10.1. Homepage
  • 10.2. Blogposts
  • 10.3. Swarm Orange Summit
  • 10.4. Orange papers
  • 10.5. Podcasts
  • 10.6. 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