Skip to content

Hummingbot V2 + Dashboard

Hummingbot 2.0 now features a Dashboard GUI, replacing the traditional CLI for a more intuitive experience.

The recommended installation method, especially for new users, is Hummingbot + Dashboard, allowing you to easily create, backtest, and deploy strategies.

Other standalone installation options like Docker and Source are still available.

System Requirements

Cloud server or local machine

Component Specifications
Operating System Linux x64 or ARM (Ubuntu 20.04+, Debian 10+)
Memory 4 GB RAM per instance
Storage 5 GB HDD space per instance
CPU at least 1 vCPU per instance / controller

Docker Compose

Hummingbot uses Docker Compose, a tool for defining and running multi-container Docker applications.

Install Docker Desktop from the official Docker website

  1. Desktop Users:
    Install Docker Desktop from official site

  2. Headless Servers (VPS like AWS EC2 or Digital Ocean):

    curl -fsSL https://get.docker.com -o get-docker.sh
    sh get-docker.sh
    

Prerequisites

  • Docker Desktop installed
  • WSL2 enabled
  • Ubuntu distribution installed

Always run commands in:
Ubuntu Terminal (Start Menu → Ubuntu)

Installation Steps

Hummingbot Deploy is a dedicated repo that allows users to quickly deploy Hummingbot using the Dashboard as the front end UI. The compose file spins up containers for the Dashboard, Backend-API as well as the Hummingbot Broker.

git clone https://github.com/hummingbot/deploy.git
cd deploy
bash setup.sh

The setup script will pull the Docker images defined in repo's docker-compose.yml file and start them as new containers:

[+] Running 7/7
  Network deploy_emqx-bridge   Created
  Volume "deploy_emqx-data"    Created
  Volume "deploy_emqx-log"     Created
  Volume "deploy_emqx-etc"     Created
  Container dashboard          Started 
  Container backend-api        Started 
  Container hummingbot-broker  Started 

After all containers have started, access the Dashboard at http://localhost:8501 in your browser.

Cloud Servers

If you are using a cloud server or VPS, replace localhost with the IP of your server. You may need to edit the firewall rules to allow inbound connections to the necessary ports.


Dashboard Quickstart

Once you've installed Dashboard, check out the Hummingbot Dashboard Quickstart guide, or the links below with a short explanation of each page (also in the sidebar).

Standalone Hummingbot

Need help deciding?

See Installation Overview for comparison of different methods.