Deploy Hummingbot Instance
This installs a single Hummingbot instance as a Docker container.
Prerequisites
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
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
docker compose
You should see a response that start with:
Usage: docker compose [OPTIONS] COMMAND
1. Launch network
Clone this repo to your machine:
git clone https://github.com/hummingbot/deploy-examples.git
Alternatively, 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.
From that directory, run the following command to pull the image and start the instance:
docker-compose up -d
After the images have been downloaded, you should see the following output:
[+] Running 1/1
⠿ Container hummingbot Started
Attach to the instance:
docker attach hummingbot
You should see the Hummingbot welcome screen:
2. Set permissions
Run this command in root directory to grant read/write permission to the hummingbot_files folder:
sudo chmod -R a+rw ./hummingbot_files
To get started with Hummingbot, check out the following docs:
Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your containers:
Create the Compose project
docker-compose up -d
Stop the Compose project
docker-compose down
Update the Compose project for the latest images
docker-compose up --force-recreate --build -d
Give all users read/write permissions to local files
sudo chmod 666 *.*
Attach to the container
docker attach <container-name>
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 <container-name>
Remove a container
docker rm <container-name>