hummingbot-dashboard/INSTALLATION.md

This repository is maintained by Hummingbot Foundation as a companion for users of Hummingbot, the open source framework for building high-frequency crypto trading bots.

Requirements

• 8 GB memory or more (On AWS, this is a t2.large instance)
• Linux / Debian / MacOS

Installation

1 - Install dependencies:

• Docker Engine
• Miniconda or Anaconda:

2 - Clone repo and navigate to the created directory

git clone https://github.com/hummingbot/dashboard.git
cd dashboard

3 - Create conda environment and install dependencies

make env_create

4 - Activate the isolated 'conda' environment

conda activate dashboard

5 - Start the dashboard

streamlit run main.py

Updating

To update the dashboard environment for changes to dependencies defined in environment.yml, remove the environment and re-create it:

make env_remove
make env_create

To updated the dashboard source for latest version, run:

cd dashboard
git pull

Troubleshooting

Docker permissions

If you get an error like Permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock, run this command to enable Docker permissions:

sudo chmod 6666 /var/run/docker.sock

Sym-link data directory

To use the Strategy Performance page, you need to establish a symbolic link to the data directory of your running Hummingbot instance:

The data directory differs for Docker versus Source installed Hummingbot:

• Docker installed: /path/to/hummingbot/hummingbot_files/data
• Source installed: /path/to/hummingbot/data

Create a symlink to your Hummingbot /data directory

# replace `/path/to/hummingbotdata` with the actual path
ln -s /path/to/hummingbotdata data

# if you need to remove the symlink
unlink data