Skip to content
NuCypher network intelligence crawler and web dashboard
Python CSS Other
Branch: master
Clone or download
KPrasch Merge pull request #12 from derekpierre/see-stakers
View number of stakers in the future
Latest commit 9454267 Dec 13, 2019

README.md

NuCypher Monitor

The NuCypher Monitor collects data about the NuCypher Network via the Crawler and displays this information in a UI via the Dashboard.

Installation

$ pip install -e . -r requirements.txt
Install additional development packages
$ pip install -e . -r dev-requirements.txt

Minimum Requirements

  • Installation of InfluxDB

    The Monitor Crawler stores network blockchain information in an InfluxDB time-series instance. The default connection is made to a local instance.

  • Installation of Geth Ethereum Node

    The Monitor needs a Web3 node provider to obtain blockchain data.

Usage

$ nucypher-monitor --help
Usage: nucypher-monitor [OPTIONS] COMMAND [ARGS]...

Options:
  --nucypher-version  Echo the nucypher version
  --help              Show this message and exit.

Commands:
  crawl      Gather NuCypher network information.
  dashboard  Run UI dashboard of NuCypher network.

Running the Monitor

via CLI

  1. Run InfluxDB
$ sudo influxd
  1. Run Geth node as a Web3 node provider (or use Infura)
$ geth --goerli --nousb
  1. Run the Crawler
$ nucypher-monitor crawl --provider <YOUR_WEB3_PROVIDER_URI>
  1. Run the Dashboard
$ nucypher-monitor dashboard --provider <YOUR WEB3 PROVIDER URI>
  1. The Dashboard UI is available at https://127.0.0.1:12500.

via Docker Compose

Docker Compose will start InfluxDB, Crawler, and Dashboard containers, and no installation of the monitor is required.

  1. Set Web3 Provider URI environment variable

    NOTE: local ipc is not supported when running via Docker

export WEB3_PROVIDER_URI=<YOUR WEB3 PROVIDER URI>
  1. Run Docker Compose
docker-compose -f deploy/docker-compose.yml up
  1. The Dashboard UI is available on port 12500.
You can’t perform that action at this time.