Skip to content

Latest commit

 

History

History
110 lines (69 loc) · 3.85 KB

README.md

File metadata and controls

110 lines (69 loc) · 3.85 KB
Raw

driver-ipfs (uplink v1.0.5)

Codacy Badge Go Report Card Cloud Build

Overview

The IPFS Driver connects to an IPFS server, takes a backup of the specified files and uploads the backup data on Storj network.

Usage:
  driver-ipfs [command] <flags>

Available Commands:
  help        Help about any command
  store       Command to upload data to a Storj V3 network.
  download    Command to download data from a Storj V3 network.
  version     Prints the version of the tool

store - Connect to the specified IPFS (default: ipfs_property.json). Back-up of the IPFS is generated using tooling provided by IPFS and then uploaded to the Storj network. Connect to a Storj v3 network using the access specified in the Storj configuration file (default: storj_config.json).

download - Connect to the specified IPFS (default: ipfs_property.json). Connect to a Storj v3 network using the access specified in the Storj configuration file (default: storj_config.json). Download the data using file hash and download location specified in the Storj download configuration file (default: storj_download.json).

Sample configuration files are provided in the ./config folder.

Note: This driver can only be used for uploading and downloading files, directories are not yet supported.

Requirements and Install

To build from scratch, install the latest Go.

Note: Ensure go modules are enabled (GO111MODULE=on)

Option #1: clone this repo (most common)

To clone the repo

git clone https://github.com/storj-thirdparty/driver-ipfs.git

Then, build the project using the following:

cd driver-ipfs
go build

Option #2: go get into your gopath

To download the project inside your GOPATH use the following command:

go get github.com/storj-thirdparty/driver-ipfs

Connect to IPFS Server

Make sure you are connected to IPFS server. If not, run the ipfs daemon in another terminal to join your node to the public network:

$ ipfs daemon

Run (short version)

Once you have built the project run the following commands as per your requirement:

Get help
$ ./driver-ipfs --help
Check version
$ ./driver-ipfs --version
Upload data from local storage using ipfs and upload to Storj
$ ./driver-ipfs store
Download backup from Storj using earlier created ipfs file hash
$ ./driver-ipfs download

Documentation

For more information on runtime flags, configuration, testing, and diagrams, check out the Detail or jump to: