https://github.com/kickeddroid/ipfs-lite-docker

https://github.com/kickeddroid/ipfs-lite-docker

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/kickeddroid/ipfs-lite-docker
• Owner: KickedDroid
• License: apache-2.0
• Created: 2019-11-12T23:31:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-12T23:35:27.000Z (over 6 years ago)
• Last Synced: 2025-02-08T01:43:09.149Z (over 1 year ago)
• Language: Go
• Size: 142 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# IPFS-Lite







[![Build Status](https://travis-ci.org/hsanjuan/ipfs-lite.svg?branch=master)](https://travis-ci.org/hsanjuan/ipfs-lite)

[![Godoc](https://godoc.org/github.com/hsanjuan/ipfs-lite?status.svg)](http://godoc.org/github.com/hsanjuan/ipfs-lite)

IPFS-Lite is an embeddable, lightweight IPFS peer which runs the minimal setup

to provide an `ipld.DAGService`. It can:

* Add, Get, Remove IPLD Nodes to/from the IPFS Network (remove is a local blockstore operation).

* Add single files (chunk, build the DAG and Add) from a `io.Reader`.

* Get single files given a their CID.

It needs:

* A [libp2p Host](https://godoc.org/github.com/libp2p/go-libp2p#New)

* A [libp2p DHT](https://godoc.org/github.com/libp2p/go-libp2p-kad-dht#New)

* A [datastore](https://godoc.org/github.com/ipfs/go-datastore) like [BadgerDB](https://godoc.org/github.com/ipfs/go-ds-badger)

Some helper functions are provided to

[initialize these quickly](https://godoc.org/github.com/hsanjuan/ipfs-lite#SetupLibp2p).

It provides:

* An [`ipld.DAGService`](https://godoc.org/github.com/ipfs/go-ipld-format#DAGService)

* An [`AddFile` method](https://godoc.org/github.com/hsanjuan/ipfs-lite#Peer.AddFile) to add content from a reader

* A [`GetFile` method](https://godoc.org/github.com/hsanjuan/ipfs-lite#Peer.GetFile) to get a file from IPFS.

The goal of IPFS-Lite is to run the **bare minimal** functionality for any

IPLD-based application to interact with the IPFS Network by getting and

putting blocks to it, rather than having to deal with the complexities of

using a full IPFS daemon, and with the liberty of sharing the needed libp2p

Host and DHT for [other things](https://github.com/ipfs/go-ds-crdt).

## License

Apache 2.0