Prerequisites — Hyperledger Fabric Docs main documentation Hyperledger Fabric Docs       Introduction What’s new in Hyperledger Fabric v2.x Release notes Key Concepts Getting Started - Install Prerequisites Mac Homebrew Git cURL Docker Go JQ Linux Git cURL Docker Go JQ Windows Docker WSL2 Microsoft VS Code (Optional) Git For Windows (Optional) Notes Install Fabric and Fabric Samples Fabric Contract APIs and Application APIs Getting Started - Run Fabric Tutorials Deploying a production network Operations Guides Upgrading to the latest release Commands Reference Architecture Reference Frequently Asked Questions Contributions Welcome! Glossary Releases Still Have Questions? Status Hyperledger Fabric Docs Getting Started - Install Prerequisites View page source Prerequisites¶ The following prerequisites are required to run a Docker-based Fabric test network on your local machine. Mac¶ Homebrew¶ For macOS, we recommend using Homebrew to manage the prereqs. $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" $ brew --version Homebrew 2.5.2 The Xcode command line tools will be installed as part of the Homebrew installation. Once Homebrew is ready, installing the necessary prerequisites is very easy: Git¶ Install the latest version of git if it is not already installed. $ brew install git $ git --version git version 2.23.0 cURL¶ Install the latest version of cURL if it is not already installed. $ brew install curl $ curl --version curl 7.64.1 (x86_64-apple-darwin19.0) libcurl/7.64.1 (SecureTransport) LibreSSL/2.8.3 zlib/1.2.11 nghttp2/1.39.2 Release-Date: 2019-03-27 Docker¶ Install the latest version of Docker Desktop if it is not already installed. Since Docker Desktop is a UI application on Mac, use cask to install it. Homebrew v2.x: $ brew cask install --appdir="/Applications" docker Homebrew v3.x: $ brew install --cask --appdir="/Applications" docker Docker Desktop must be launched to complete the installation so be sure to open the application after installing it: $ open /Applications/Docker.app Once installed, confirm the latest versions of both docker and docker-compose executables were installed. $ docker --version Docker version 19.03.12, build 48a66213fe $ docker-compose --version docker-compose version 1.27.2, build 18f557f9 Note: Some users have reported errors while running Fabric-Samples with the Docker Desktop gRPC FUSE for file sharing option checked. Please uncheck this option in your Docker Preferences to continue using osxfs for file sharing. Go¶ Optional: Install the latest Fabric supported version of Go if it is not already installed (only required if you will be writing Go chaincode or SDK applications). $ brew install go@1.24.2 $ go version go1.24.2 darwin/amd64 JQ¶ Optional: Install the latest version of jq if it is not already installed (only required for the tutorials related to channel configuration transactions). $ brew install jq $ jq --version jq-1.6 Linux¶ Git¶ Install the latest version of git if it is not already installed. $ sudo apt-get install git cURL¶ Install the latest version of cURL if it is not already installed. $ sudo apt-get install curl Docker¶ Install the latest version of Docker if it is not already installed. sudo apt-get -y install docker-compose Once installed, confirm that the latest versions of both Docker and Docker Compose executables were installed. $ docker --version Docker version 19.03.12, build 48a66213fe $ docker-compose --version docker-compose version 1.27.2, build 18f557f9 Make sure the Docker daemon is running. sudo systemctl start docker Optional: If you want the Docker daemon to start when the system starts, use the following: sudo systemctl enable docker Add your user to the Docker group. sudo usermod -a -G docker Go¶ Optional: Install the latest version of Go if it is not already installed (only required if you will be writing Go chaincode or SDK applications). JQ¶ Optional: Install the latest version of jq if it is not already installed (only required for the tutorials related to channel configuration transactions). Windows¶ Docker¶ Install the latest version of Docker Desktop if it is not already installed. WSL2¶ Both the Fabric documentation and Fabric samples rely heavily on a bash environment. The recommended path is to use WSL2 (Windows Subsystem for Linux version 2) to provide a native Linux environment and then you can follow the Linux prerequisites section (excluding the Linux Docker prerequisite as you already have Docker Desktop) and install them into your WSL2 linux distribution. WSL2 may not be installed by default; you can check and install WSL2 by going into “Programs and Features”, clicking on “Turn Windows features on or off” and ensuring that both “Windows Subsystem For Linux” and “Virtual Machine Platform” are selected. Next you will need to install a Linux distribution such as Ubuntu-22.04 and make sure it’s set to using version 2 of WSL. Refer to Install WSL for more information. Finally, you need to ensure Docker Desktop has integration enabled for your distribution so it can interact with Docker elements, such as a bash command window. To do this, open the Docker Desktop gui and go into settings, select Resources and them WSL Integration and ensure the checkbox for enable integration is checked. You should then see your WSL2 linux distribution listed (if you don’t then it is probably because it is still a WSL1 distribution and needs to be converted to WSL2) and you can then toggle the switch to enable integration for that distro. Refer to Docker Desktop WSL2 backend for more information Microsoft VS Code (Optional)¶ Microsoft VS Code provides an IDE that has tight integration with WSL2 Linux Distributions. Search the Microsoft Marketplace in VS Code for the Remote Development extension pack for more information. This pack includes, among other things, the Remote - WSL extension and the Remote - Containers extension. Git For Windows (Optional)¶ Although not required, if you do decide to install Git on Windows and manage the Fabric repositories natively (as opposed to within WSL2 and its Git installation), then make sure you configure Git as follows: Update the following git configurations: git config --global core.autocrlf false git config --global core.longpaths true You can check the setting of these parameters with the following commands: git config --get core.autocrlf git config --get core.longpaths These output from these commands should be false and true respectively. Notes¶ These prerequisites are recommended for Fabric users. If you are a Fabric developer, please refer to the instructions for Setting up the development environment. Next Previous © Copyright Hyperledger 2020-2023. This work is licensed under a Creative Commons Attribution 4.0 International License Built with Sphinx using a theme provided by Read the Docs.