This configuration requires Docker Compose, a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install Docker Desktop, which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.

Docker Desktop is available on:

Apple M1/M2 and other ARM machines

If you have a recent Mac that uses Apple Silicon (M1/M2) chipset or another ARM-based machine, you need to change the image tag to ensure that you pull a container that is optimized for your chip architecture.

Use an IDE like VSCode to edit the docker-compose.yml file. Change the the image tag from latest to latest-arm to pull the image built for ARM-based machines. You can also comment out the line that contains latest and uncomment the line that contains latest-arm:

# image: hummingbot/hummingbot:latest
image: hummingbot/hummingbot:latest-arm

Afterwards, save the file and proceed to the next step.

If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-based machine, you don't need to make any changes before deploying a container.

Getting Started

If you have installed Docker Compose successfully, the docker-compose command should be available in Terminal/Bash:

docker-compose

Usage:  docker compose [OPTIONS] COMMAND

Clone this repo or copy the docker-compose.yml file to a directory on your machine where you want to store your Hummingbot files. This is where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.

Auto-starting a script/strategy lets you start a bot from the command line, skipping the Hummingbot UI. However, before you can auto-start a script or strategy, you will do need two things first:

Set the password used to encrypt your keys (CONFIG_PASSWORD)
Define your script or strategy config file (CONFIG_FILE_NAME)

The sample docker-compose.yml contains dummy values for these variables. Let's fill them in!

Setting the Hummingbot password

Start the bot with the following command:

docker-compose up -d

You should see the following output:

[+] Running 1/1
 ⠿ Container autostart_hummingbot_compose-bot-1  Started

After it has started, attach to the instance:

docker attach autostart_hummingbot_compose-bot-1

If installation was successful, you should see the Hummingbot welcome screen:

Set your Hummingbot password and write it down. This is the CONFIG_PASSWORD environment variable in your docker-compose.yml file.

Defining your script or strategy

You can auto-start either a Script or a Strategy.

Scripts are Python files that contain all strategy logic. If you define a .py file as CONFIG_FILE_NAME, Hummingbot assumes it's a script file and looks for the .py file in the scripts directory. See scripts/simple_pmm_example.py for an example.

Strategies are configurable strategy templates. If you define a .yml file as CONFIG_FILE_NAME, Hummingbot assumes it's a strategy config file and looks for the .yml file in the conf/strategies directory. See conf/strategies/conf_pure_mm_1.yml for an example.

Now, use an IDE like VSCode to edit the docker-compose.yml file.

Uncomment out the lines that define the CONFIG_PASSWORD and CONFIG_FILE_NAME environment variables:

    # environment:
      # - CONFIG_PASSWORD=[your-password]
      # - CONFIG_FILE_NAME=simple_pmm_example.py
      # - CONFIG_FILE_NAME=conf_pure_mm_1.yml

Uncomment the environment: line, the CONFIG_PASSWORD line and add the password you set earlier, and one of CONFIG_FILE_NAME lines. Then, replace CONFIG_PASSWORD and CONFIG_FILE_NAME with the values you defined above. The final section of the file should look like this:

    environment:
      - CONFIG_PASSWORD=[your-password]
      - CONFIG_FILE_NAME=simple_pmm_example.py

Afterwards, save the file. Now, the script or strategy will auto-start when you create the container:

docker-compose up -d

Useful Docker Commands

Use the commands below or use the Docker Desktop application to manage your Hummingbot container:

Create the container

docker-compose up -d

Attach to the container

docker attach autostart_hummingbot_compose-bot-1

Detach from the container and return to command line

Press keys Ctrl + P then Ctrl + Q

Update the container to the latest image

docker-compose up --force-recreate --build -d

List all containers

docker ps -a

Stop a container

docker stop <instance-name>

Remove a container

docker rm <instance-name>