From Source

Prerequisites

To run this repository from source, you need to have the following installed:

• node.js (recommended version 20.x)
• yarn
• git
• speedtest (recommended)
  • or alternatively: speedtest-cli
  • or alternatively: use local file

Setup

After that, download and build the project (might take a few minutes)

Linux

git clone https://github.com/MauriceNino/dashdot \
  && cd dashdot \
  && yarn \
  && yarn build:prod

Windows (Cmd)

git clone https://github.com/MauriceNino/dashdot ^
  && cd dashdot ^
  && yarn ^
  && yarn build:prod

When done, you can run the dashboard by executing:

Linux

sudo -E yarn start

Windows (Cmd)

For the most accurate results, it is recommended to start the Cmd as an Admin.

yarn start

info

In case you get a speedtest related error, you might have to accept the license before being able to start your dashboard.

For this, run the following in your terminal:

speedtest --accept-license

Configuration

Config options can optionally passed using environment variables.

Linux

export DASHDOT_PORT="8080" \
  && sudo -E yarn start

Windows (Cmd)

set DASHDOT_PORT="8080" ^
  && yarn start

Update

You can update your Dash. instance, by stopping your instance, then running the following commands and in the end, restart your instance.

Linux

git pull --rebase \
  && yarn \
  && yarn build:prod

Windows (Cmd)

git pull --rebase ^
  && yarn ^
  && yarn build:prod