dataserv-client 2.0.0

Client for storing and auditing data. http://storj.io

Setup

Windows

Download latest windows release from github.

Extarct the zip file to the folder where you wish to have it installed.

$ dataserv-client.exe version

The dataserv-client will automaticlly update when new releases are made.

Ubuntu Linux

Install client

$ sudo apt-get install python3-pip
$ sudo pip3 install dataserv-client
$ dataserv-client version

Update client

$ sudo pip3 install dataserv-client --upgrade
$ dataserv-client version

OSX

Install client

$ brew install python3
$ rehash
$ pip3 install dataserv-client
$ dataserv-client version

Update client

$ pip3 install dataserv-client --upgrade
$ dataserv-client version

Command line interface usage

Quickstart example

# optional, payout address and master secret are generated automatically
$ dataserv-client --set_payout_address=<BITCOIN_ADDRESS> show_config

# register your node
$ dataserv-client register

# create shards
$ dataserv-client build

# let the network know you are online
$ dataserv-client poll

Argument ordering

$ dataserv-client <program arguments> COMMAND <command arguments>

Argument ordering example

$ dataserv-client --max_size=10G build --cleanup

Show program help, optional arguments and commands

$ dataserv-client --help
usage: dataserv-client [-h] [--url URL] [--max_size MAX_SIZE]
                       [--store_path STORE_PATH] [--config_path CONFIG_PATH]
                       [--debug] [--set_master_secret SET_MASTER_SECRET]
                       [--set_payout_address SET_PAYOUT_ADDRESS]
                       <command> ...

Dataserve client command-line interface.

optional arguments:
  -h, --help            show this help message and exit
  --url URL             Url of the farmer (default:
                        http://status.driveshare.org).
  --max_size MAX_SIZE   Maximum data size in bytes. (default: 1073741824).
  --store_path STORE_PATH
                        Storage path. (default: /home/fabe/.storj/store).
  --config_path CONFIG_PATH
                        Config path. (default: /home/fabe/.storj/config.json).
  --debug               Show debug information.
  --set_master_secret SET_MASTER_SECRET
                        Base64 encoded master secret to generate node wallet.
  --set_payout_address SET_PAYOUT_ADDRESS
                        Address from wallet used if not given.

commands:
  <command>
    version             Print version number.
    register            Register a bitcoin address with farmer.
    ping                Ping farmer with given address.
    poll                Continuously ping farmer with given address.
    build               Fill the farmer with data up to their max.
    show_config         Display saved config.

Show command help and optional arguments

$ dataserv-client <COMMAND> --help

version command

Show version number

$ dataserv-client version

register command

Register address with default farmer.

$ dataserv-client register

Register address with default farmer and use cold storage wallet as payout_address.

$ dataserv-client register --payout_address=<BITCOIN_ADDRESS>

Register address with custom farmer.

$ dataserv-client --url=<CUSTOM_FARMER_URL> register

ping command

Ping address:

$ dataserv-client ping

poll command

Poll address:

$ dataserv-client poll

build command

Build

$ dataserv-client build

Build with custom max data size and store path

$ dataserv-client --store_path=<PATH_TO_FOLDER> --max_size=<MAX_DATA_SIZE_IN_BYTES> build

# optional max_size syntax
--max_size=1K  # 1024^1 bytes
--max_size=1KB # 1000^1 bytes
--max_size=1M  # 1024^2 bytes
--max_size=1MB # 1000^2 bytes
--max_size=1G  # 1024^3 bytes
--max_size=1GB # 1000^3 bytes
--max_size=1T  # 1024^4 bytes
--max_size=1TB # 1000^4 bytes
--max_size=1P  # 1024^5 bytes
--max_size=1PB # 1000^5 bytes

Build and cleanup files afterwards

$ dataserv-client build --cleanup

Build and force rebuild of any previously generated files.

$ dataserv-client build --rebuild

Build custom shard height

$ dataserv-client build --height=<NUMBER_OF_SHARDS>