This forked repository of IBM/IPFSfB is one of the most renowned versions of IPFSfB, the IPFSfB orginal author's repository. Where the newest version of IPFSfB will arrive, there is a place.
This repository empowers users to leverage the nature of the IPFS Web UI feature, refined p2p, p2s and p2sp network to add server functionality of Web UI, and add server-only (so) senario.
- Private IPFS Web UI for ipfs-server with download and upload functionalites.
- New desgin of server-only (so) network.
- Renewed p2p, p2s, and p2sp networks for private IPFS Web UI compatibility.
The private IPFS Web UI is not ready for production usage if only bringing a network up by a single script like ./pnet up <network>. To use all Web UI functionalities, we should configure it through Private IPFS Web UI tutorial.
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.
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.
Currently we have two flows for each contributors and users.
The contributor flow tells you how to contribute to IPFSfB. You can also refer to the contributors guide.
The user flow corresponds how to set up a private network, which you can refer to running a private network.
Building from source with IPFSfB repository:
go get -u github.com/IBM/IPFSfBBuilding from source with IPFSfB tools, once the repository is downloaded, run:
make swarmkeygenor build all utilities:
make allAfter build, make sure to add $GOPATH/bin to your bash/zsh environment or export it to PATH:
export PATH=$PATH:$GOPATH/bin- Running a private network
- Runtime instructions
- Scenarios
- Considerations
- Architecture
- Troubleshooting
- Related links
- License
Currently, we are offering simple network as one of the samples. It contains four senarios including peer-to-peer, peer-to-server, peer to peer and to server, and server-only. You can follow the tutorial to envision and run a private network.
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.
One of the samples, simple network is avaliable in four scenarios (p2p, p2s, p2sp and so).
The scenario guidelines are available at docs/tutorial/simple-network.md.
You can access and download network specific binaries and images through bootstrap.sh. Once downloaded, you can run these network scenarios by pnet.sh.
Each scenarios have end-to-end testing, located in samples/simple-network/e2e.
There are several considerations for the roadmap of IPFSfB.
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.
- General data interface for any blockchain
- VS Code extension
- Hyperledger Fabric extension
We have made a document references for the architecture diagrams. You can refer to the architecture document for the architecture of each scenarios.
If you have encountered a problem for running IPFSfB, raise an issue and mention one of the maintainers in the maintainers board.
- 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.