7/14/2020 GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

IBM / IPFSfB

InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based
on InterPlanetary File System.

developer.ibm.com/patterns/build-first-private-blockchain-network-interplanetary-file-system

Apache-2.0 License

56 stars 19 forks

Star Watch

Code Issues Pull requests Actions Projects Wiki Security Insights

Dismiss
Join GitHub today
GitHub is home to over 50 million developers
working together to host and review code, manage
projects, and build software together.

Sign up

master

5sWind committed on May 24, 2019 …

View code

README.md

InterPlanetary File System for Business

(IPFSfB)
build passing

This repository contains instructions to build a private, unstructured data storage network
for any blockchain on distributed file system, InterPlanetary File System for Business (IPFSfB),
using crypto tools and Docker images with Docker and Docker Compose to provision the
enterprise blockchain storage network.

https://github.com/IBM/IPFSfB 1/6
7/14/2020 GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

Overview
InterPlanetary File System for Business (IPFSfB) is based on InterPlanetary File System, which
aim to provide an enterprise form, unstructured data storage network for any blockchain.

Flow
Currently we have two flows for each contributors and users.

Flow 1: for contributors

The contributor flow tells you how to contribute to IPFSfB. You can also refer to the
contributors guide.

Flow 2: for users

https://github.com/IBM/IPFSfB 2/6
7/14/2020 GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

The user flow corresponds how to set up a private network, which you can refer to running a
private network.

Prerequisites
Docker
Go
Git

Building from source

Building from source with IPFSfB repository:

go get -u github.com/IBM/IPFSfB

Building from source with IPFSfB tools, once the repository is downloaded, run:

make swarmkeygen

or build all utilities:

make all

https://github.com/IBM/IPFSfB 3/6
7/14/2020 GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

Steps
1. Running a private network
2. Runtime instructions
3. Scenarios
4. Considerations
5. Architecture
6. Troubleshooting
7. Related links
8. License

1. Running a private network

Currently, we are offering simple network as one of the samples. It contains three senarios
including peer-to-peer, peer-to-server, and peer to peer and to server. You can follow the
tutorial to envision and run a private network.

2. Runtime instructions

If you are running a private network, config.sh file will help containers to check runtime
health. Regularly inspect docker containers log in the runtime environment may be helpful.

3. Scenarios
One of the samples, simple network is avaliable in three scenarios (p2p, p2s, and p2sp).

The scenario guidelines are available at docs/tutorial/simple-network.md.

Accessing and running

You can access and download network specific binaries and images through bootstrap.sh.
Once downloaded, you can run these network scenarios by pnet.sh.

End-to-end testing
Each scenarios have end-to-end testing, located in samples/simple-network/e2e.

4. Considerations
There are several considerations for the roadmap of IPFSfB.

Performance and production

https://github.com/IBM/IPFSfB 4/6
7/14/2020 p
GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

For the private or enterprise network performance, such as uploading a file, downloading a
file, hosting a web, and even collaborating a documentation from the network, we need
more network connection cases and speed performance to test the network.

IPFSfB production will not only include simple network scenarios for private network, but
also give a vision for clustering, consensus enabled enterprise network.

Extension
General data interface for any blockchain
VS Code extension
Hyperledger Fabric extension

5. Architecture
We have made a document references for the architecture diagrams. You can refer to the
architecture document for the architecture of each scenarios.

6. Troubleshooting
If you have encountered a problem for running IPFSfB, raise an issue and mention one of
the maintainers in the maintainers board.

7. Related links
go-ipfs: this repository is based on InterPlanetary File System implementation in Go.
Hyperledger Fabric - Building Your First Network: the technical design of each scenarios
of simple network are referenced to build your first network (BYFN) sample.

8. License
This code pattern is licensed under the Apache Software License, Version 2. Separate third-
party code objects invoked within this code pattern are licensed by their respective
providers pursuant to their own separate licenses. Contributions are subject to the
Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version
2.

Apache Software License (ASL) FAQ

Releases

1 tags
https://github.com/IBM/IPFSfB 5/6
7/14/2020 GitHub - IBM/IPFSfB: InterPlanetary File System for Business (IPFSfB) is an enterprise blockchain storage network based on InterPl…

Contributors 3

5sWind 5sWind

ImgBotApp ImgBotApp

ljbennett62 ljbennett62

Languages

Go 45.7% Dockerfile 32.3% Makefile 22.0%

https://github.com/IBM/IPFSfB 6/6