[Quickstart] Install Hummingbot

Note

You can now install Hummingbot using GUI Installer on Windows, MacOS and coming soon to Linux.

Below, we show you how to install Hummingbot using our installation scripts for each supported platform. We highlight the Docker image method for new users since it contains all necessary dependencies.

If you would like to install from source or see the detailed installation instructions, see Installation in the User Manual.

Step 1: Install Docker

If you don't already have Docker, we show you how to install Docker for each platform. Docker is an open source containerization product that pre-packages all dependencies into a single container, greatly simplifying the installation process.

Linux/Cloud

Install tmux to allow you to easily run Hummingbot remotely:

Note

To learn more about tmux please visit getting started with tmux.

1
2
sudo apt-get update
sudo apt-get install -y tmux
1
sudo yum -y install tmux

Install Docker:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# 1) Download Docker install script
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/install-docker/install-docker-ubuntu.sh

# 2) Enable script permissions
chmod a+x install-docker-ubuntu.sh

# 3) Run installation
./install-docker-ubuntu.sh

# Note: The script will close the terminal window

Restart Terminal

The above commands will close your terminal/bash window in order to enable the correct permissions for the docker command. Close and restart your bash/terminal window if it did not close automatically.

MacOS

You can install Docker by downloading an installer from the official page. After you have downloaded and installed Docker, restart your system if necessary.

Windows

Download the latest version Docker Toolbox .exe file at the following link: Docker Toolbox Releases.

Docker Download

Locate the installer in the downloads folder and run a full installation with included VirtualBox and Git for Windows. (Git is the default shell used by Docker)

Docker Installation

By default, a shortcut to the Docker Quickstart terminal will be created on your desktop. You can open Docker Toolbox using this shortcut.

Docker Startup

Step 2: Install Hummingbot

Using Automated Docker Scripts

We have created helper scripts that simplify the process of installing and running Hummingbot with Docker:

  • create.sh: Creates a new instance of Hummingbot
  • start.sh: Starts Hummingbot
  • update.sh: Updates Hummingbot

The scripts help you install an instance of Hummingbot and set up folders to house your logs and configuration files:

1
2
3
hummingbot_files       # Top level folder for hummingbot-related files
├── hummingbot_conf    # Maps to hummingbot's conf/ folder, which stores configuration files
└── hummingbot_logs    # Maps to hummingbot's logs/ folder, which stores log files

Warning

When you update Hummingbot, use the update.sh helper script. Do not delete these folders; otherwise, your configuration info may be lost.

Linux/Cloud

Open a new Bash window and run tmux to create a new process:

1
tmux

Aftewards, run the following commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# 1) Download Hummingbot helper scripts
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/create.sh
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/start.sh
wget https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/update.sh

# 2) Enable script permissions
chmod a+x *.sh

# 3) Run install script
./create.sh

Afterwards, you should see the Hummingbot client interface. Proceed to Configure a Bot.

MacOS

Open a Terminal window and run the following commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# 1) Download Hummingbot helper scripts
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/create.sh -o create.sh
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/start.sh -o start.sh
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/update.sh -o update.sh

# 2) Enable script permissions
chmod a+x *.sh

# 3) Run install script
./create.sh

Afterwards, you should see the Hummingbot client interface. Proceed to Configure a Bot.

Windows

Open Docker Toolbox using the Docker Quickstart desktop shortcut. You should see the following screen:

Docker Ready

From inside the Docker Toolbox window, run the following commands:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# 1) Navigate to root folder
cd ~

# 2) Download Hummingbot helper scripts
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/create.sh -o create.sh
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/start.sh -o start.sh
curl https://raw.githubusercontent.com/CoinAlpha/hummingbot/development/installation/docker-commands/update.sh -o update.sh

# 3) Enable script permissions
chmod a+x *.sh

# 4) Run install script
./create.sh

Afterwards, you should see the Hummingbot client interface. Proceed to Configure a Bot.


Next: Configure Your First Trading Bot