README.md

Getting started

Welcome to the Linux Foundation Hyperledger Project documentation README. This page contains:

• Getting started doc links
• Quickstart doc links
• Table of Contents links to the complete library

If you are new to the project, you can begin by reviewing the following documents:

• Whitepaper WG
• Requirements WG
• Glossary: to understand the terminology that we use throughout the website and project.

When you are ready to start building applications or to otherwise contribute to the project, we strongly recommend that you read our protocol specification for the technical details. Procedurally, we use the agile methodology with a weekly sprint, organized by issues, so take a look to familiarize yourself with the current work.

Quickstart documentation

In addition to the Getting started documentation, the following quickstart topics are available:

• Fabric FAQs
• Canonical use cases
• Development environment set-up
• Chaincode development environment
• APIs
• Network setup

Table of Contents

This table of contents provides links to the complete documentation library:
Overview docs; Reference docs; API and chaincode developer docs; Network operations docs; Security administration docs; Use cases and demos

Overview docs:

• Hyperledger project
• Whitepaper
• Fabric README
• Glossary
• Figures & Diagrams
• Protocol specification:
  • Introduction (fabric, terminology)
  • Fabric:
    • Architecture (Membership Services, Blockchain Services, Chaincode Services, Events, API, CLI)
    • Topology (SVP, MVP, Multichain)
    • Protocol (Messages, Ledger, Chaincode, Consensus, Events)
    • Security (Business Security, User Security, Transaction Security, App. ACL, Wallet, Network Security (TLS))
    • PBFT Consensus Plugin
    • API (REST service, REST API, CLI)
    • Application Model (Composition, Sample)
    • Future (Systems Integration, Performance & Scalability, Consensus Plugins, Additional Languages)

Reference docs:

• Contributing
• Communicating
• Project Lifecycle
• License
• Maintainers

API and chaincode developer docs:

• Setting up the development environment:
  • Overview (Vagrant/Docker)
  • Prerequisites (Git, Go, Vagrant, VirtualBox, BIOS)
  • Steps (GOPATH, Windows, Clone Peer, VM Vagrant
• Building the fabric core
• Building outside of Vagrant
• Code contributions
• Coding Golang
• Headers
• Writing Chaincode
• Writing, Building, and Running Chaincode in a Development Environment
• Chaincode FAQ
• Setting Up a Network
• Setting Up a Network For Development:
  • Docker
  • Validating Peers
  • Run chaincode
  • Consensus Plugin
• Working with CLI, REST, and Node.js
• APIs - CLI, REST, and Node.js:
  • CLI
  • REST
  • Node.js Application
• Configuration
• Logging
• Logging control:
  • Overview
  • Peer
  • Go
• Generating grpc code
• Adding or updating Go packages
• SDK

Network operations docs:

• Setting Up a Network
• Consensus Algorithms

Security administration docs:

• Certificate Authority (CA) Setup:
  • Enrollment CA
  • Transaction CA
  • TLS CA
  • Configuration
  • Build and Run
    
• Application ACL:
  • Fabric Support
  • Certificate Handler
  • Transaction Handler
  • Client
  • Transaction Format
  • Validators
  • Deploy Transaction
  • Execute Transaction
  • Chaincode Execution