zakhar-kogan / deploy-examples

This repository provides various examples of how to deploy Hummingbot using Docker.

Deploying Hummingbot with Docker

Intro

This repository provides various examples of how to deploy Hummingbot using Docker Compose. Hummingbot is an open source framework that helps you build automated trading strategies, or bots that run on cryptocurrency exchanges, and Docker Compose is a tool for defining and running multi-container Docker applications

It also contains standalone bash scripts that assist you to setting up Hummingbot with Docker, but we recommend using Docker Compose instead.

See Docker for more information about how to install and use Docker.

How do I use this repo?

Each folder showcases a different deployment type using Docker Compose, such as:

• A single Hummingbot instance along with a dashboard that analyzes it
• A single Hummingbot instance that auto-starts a strategy or script
• Linked Hummingbot and Gateway instances
• Multiple instances of Hummingbot

The important files in each folder are:

• docker-compose.yml: A sample configuration file for that deployment type.
• README.md: A detailed README file that guides users through the steps required to deploy Hummingbot using Docker, including how to build and run the containers, how to configure the bot, and how to monitor its performance.

After you have configured it properly, each deployment can be launched with the command:

docker compose up -d

Deployment types using Docker Compose

Hummingbot with Dashboard

⭐️⭐️⭐️ We recommend that new Hummingbot users follow this route ⭐️⭐️⭐️

This installs a single Hummingbot instance with a companion Hummingbot Dashboard running.

Simple Hummingbot Compose

This installs a single Hummingbot instance as a Docker container.

Autostart Hummingbot Compose

This installs a single Hummingbot instance as a Docker container and automatically starts running a pre-configured script or strategy.

Hummingbot Gateway Compose

This installs a Hummingbot instance linked to a Hummingbot Gateway instance.

Multiple Hummingbot Gateway Compose

This installs two Hummingbot instances, linked to a single Hummingbot Gateway instance.

Hummingbot Gateway Broker Compose

This installs a Hummingbot instance linked to a Hummingbot Gateway instance, along with an EMQX Broker.

!!! note "Experimental deployment" This deployment is still undergoing testing, so we recommend using the standalone deployments for message brokers from the hummingbot/brokers repository.

Bash scripts (older)

These standalone bash scripts can also assist you to setting up Hummingbot and Gateway with Docker, but we recommend using Docker Compose instead.

The following operations are possible using the bash scripts:

• Create a Hummingbot container
• Update the Hummingbot image version
• Start a stopped container of Hummingbot
• Create a Gateway container
• Copy the certificates to the corresponding gateway path

Other Hummingbot Repos

• Hummingbot Docs: Official documentation for Hummingbot - we welcome contributions here too!
• Awesome Hummingbot: All the Hummingbot links
• Hummingbot StreamLit Apps: Hummingbot-related StreamLit data apps and dashboards
• Community Tools: Community contributed resources related to Hummingbot
• Brokers: Different brokers that can be used to communicate with multiple instances of Hummingbot
• Deploy Examples: Deploy Hummingbot in various configurations with Docker
• Remote Client: A remote client for Hummingbot in Python

Contributions

Hummingbot belongs to its community, so we welcome contributions! Users are encouraged to submit pull requests with their own examples and use cases for deploying Hummingbot with Docker.