Skip to content

BoboTiG/dusk-monitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dusk Node Monitoring

A dashboard for your Dusk node.

This is safe: it works outside the node, no need to install anything on the node.

Interesting links:

Dusk wallet for tips:

VKZpBrNtEeTobMgYkkdcGiZn8fK2Ve2yez429yRXrH4nUUDTuvr7Tv74xFA2DKNVegtF6jaom2uacZMm8Z2Lg2J

Install

python3 -m venv venv
. ./venv/bin/activate
python -m pip install -r requirements.txt

Run

  1. Start the local web server.
    • Open the dashboard for the setup (and for later updates, you can directly go to the /setup page).
  2. Set up the cron job.
  3. That's it!

Environment Variables

  • DATA_DIR=path/to/folder: the folder where node data will be stored, it's highly recommended using a folder outside the repository.
  • DEBUG=0: disable all print().

Commands

Update Data

The first time, it will scan the entire blockchain to find blocks generated by the node, then subsequent calls will only fetch new blocks since the last run.

Here is the cron job to update data every 5 minutes:

*/5 * * * * cd /path/to/dusk-monitor && DATA_DIR=../dusk-monitor-data/node-1 ./venv/bin/python -m app --update

Web Server

Start the local web server at http://localhost:1923:

DATA_DIR=../dusk-monitor-data/node-1 python -m app

Endpoints

Preview

Note

Those screenshots might be outdated, but the essence of the dashboard is still relevant from those pictures. Also, if you have any design skills, please take a look at #5 🙏

On desktop:

Preview on a large screen

On smartphone: