Storj Dashboard Client
Switch branches/tags
Nothing to show
Clone or download
sibblegp Merge branch 'master' of github.com:sibblegp/Storj-Dashboard-Client
* 'master' of github.com:sibblegp/Storj-Dashboard-Client:
  Split out the storjshare binary from the path
Latest commit cb52e77 Jan 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
storjreports
.gitignore Windows Final Compatibility Nov 6, 2017
LICENSE Initial commit Oct 25, 2017
MANIFEST Latest Changes Jan 15, 2018
README.md Updated Readme for Windows Nov 9, 2017
__init__.py
setup.py Latest Changes Jan 15, 2018

README.md

Storj Dashboard Client

Dashboard

Welcome to the StorJ Dashboard client. This is the installable client module for www.storjdash.com and can be used to monitor StorJ farming nodes on as many servers as you'd like. It is provided free of charge.

Windows Installation

Please go to the releases page for the latest Windows installer.

Linux Installation

Currently the client only works on Ubuntu and Debian 9.X+ distributions.

Stop now if you are using any other Linux operating system.

To get started, register for an account at StorJDash.com. You will need these credentials later.

Next, we need to check that we have a valid version of Python 3 installed. Run the following command:

python3 -V

You should see some output like:

Python 3.5.2

As long as it is above 3.5 you are okay. If it is not or the command does not run, please google about installing python 3.

Next we need to install the python 3 package manager:

sudo apt-get install -y python3-pip python3-setuptools python3-wheel

Now it's time for the fun stuff. Time to install our StorJ Dashboard Client.

Make sure you run this with pip3 and not pip.

sudo pip3 install storjdash

It's finally time to set up the client. First, we need to make sure of a few things.

  • You will need to enter your StorJDash login details. You should have a registered account at StorjDash.
  • All of your configuration files should be in their own directory.
  • Your config files should be in standard format without any additional comments.

Let's configure the client. You may wonder why this requires sudo access. This is because registration writes a config file to /etc and creates a cron job to hourly submit reports.

sudo register_storjdash

If all goes well, your server will acknowledge that it has registered and schedule an hourly update for your servers.

Let's kick off your first report!

send_storj_reports

If all is working, you should see at least one output like this:

{'server_uuid': 'caf36562-2b7b-42fa-911f-19c4ea12776f', 'node_capacity': 800000000000.0, 'current_size': 306160401105, 'node_name': 'node1', 'report_uuid': 'dbdf6fb7-6ccc-41e0-a3e5-08229a603dcd', 'storj_node_id': '1438a6ea791f5996fc63b4d180ecadb7ddd1384c'}

If you don't see this output or you see an error, seek support below.

Support

Common Questions

Windows

How do I upgrade the client and how often should I?

  • You should upgrade the client whenever there is a new release. Please go to the releases page for the latest Windows installer.

Why is the code not signed or why does it say Unknown Publisher when installing?

  • Code signature licenses are expensive and would increase the price of this project immensely. Furthermore, obtaining one requires that I have a landline and seriously, who has a landline these days?

Linux

  • You should upgrade the client as often as you can as fixes are released frequently. Run the following command.
sudo pip3 install storjdash --upgrade

Why do you need root access when registering?

  • We need root because we create a settings file in /etc and create a cron job

What should I do if I put in the wrong configs directory or I move them?

  • You can edit the "configs_directory" setting in /etc/storjdash.json

Obtaining Support

You can obtain support in several ways:

Supported Operating Systems:

  • Ubuntu 14.*
  • Ubuntu 16.*
  • Debian 9.*
  • Devuan Ascii (9.*)

Donations

If you enjoy StorJDash, you can support it by donating StorJ Tokens or ETH to:

0xabA365D78086b1e9A12555A656AEc0cB92B8f9CA

And BTC to:

1KnTsXcEMWnmF4pwHJzT9wKzfujaFmFbeD

Donators

  • koelie