Deprecated

| Master | | Develop |

#Toadserver

The toadserver is a hosted IPFS gateway that is intended to use smart contracts to manage read/write access. Files are added to IPFS then cached (pinned) to your IPFS gateway. Meanwhile, a name registry entry is created on an eris-db blockchain, mapping the file name to its IPFS hash and recording who posted what, when. This is a first stab at decentralizing GitHub.

• Uploading is handled via pure (http) POST routes from nodes who have the right keys.
• Downloading is handled via pure (http) GET routes from any node (by default -- open dl server is first use case: permissioning read access is no easy task!)

##Installation

While the toadserver is intended and recommended to run as an eris services, a cli with four commands (toadserver start | put | get | ls) is available. See this tutorial for information on setting up the toadserver using eris-cli.

##Under the hood To add a file: curl -X POST http://localhost:11113/postfile?fileName=fileName.ext --data-binary "@fileName.ext" where fileName.ext is the path to file. A few things will happen:

• 1. file will be put to IPFS and its hash returned.
• 2. a wrapper around mint-client will sign the tx (locally) and POST it to a validator node which then broadcasts it to the chain
• 3. provided the tx is valid, a namereg entry is created whereby fileName.ext points to an IPFS hash containing the contents of the POSTed file, now accesible via GET: curl -X GET http://localhost:11113/getfile?fileName=fileName.ext
• 4. file can be listed with: curl -X GET http://localhost:11113/listfiles

##Contracts Coming soon! See the library in versioned_filestore.

##What is it for? The intended use of the toadserver is for organizations or individuals to host files on a distributed platform for which read/write access is moderated. As such, a common setup would have a host running a chain with N validating nodes and IPFS gateways of +/-N nodes that do all the caching. Users accessing the platform need not (but can be incentivized to) run such nodes. The namereg entry on a chain is useful for abstracting IPFS hashes and if IPFS is a data lake, the toadserver helps you decide where to hop to. It also simplifies the process of managing hosted content on IPFS and enables various incentive schemes. Now anyone can quickly and easily spin up their own "content portal" using IPFS as a backend and an eris-db blockchain to manage read/write permissions.

##Use cases

• simple, scalable content hosting
• open data / science publishing
• run your own download server

##IPFS See Brian's article here for more information on why we love IPFS