d0zingcat/deploy
1
0
Fork 0
mirror of https://github.com/d0zingcat/deploy.git synced 2026-05-13 15:09:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates

Browse Source
This commit is contained in:
Michael Feng
2023-04-17 15:15:50 -07:00
parent bb92f3cf4b
commit 1e2be4b96f
12 changed files with 269 additions and 426 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@@ -18,4 +18,6 @@ venv.bak/
*.pem
**/gateway_files/*
**/hummingbot_files/*
**/hummingbot_files/*
**/.DS_Store

67
DOCKER.md Normal file
View File

@@ -0,0 +1,67 @@
# Docker
## Why use Docker Compose?
Using Docker for Hummingbot deployment offers several benefits, such as simplifying the installation process, enabling easy versioning and scaling, and ensuring a consistent and isolated environment for running the bot. This repository aims to help users get started with deploying Hummingbot using Docker by providing different examples that demonstrate how to set up and customize the bot according to their needs.
The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
## 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 -R a+rw <files/folders>
```
### Attach to the container
```
docker attach <container-name>
```
### Detach from the container and return to command line
Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### 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>
```

12
README.md
View File

@@ -6,17 +6,7 @@ This repository provides various examples of how to deploy Hummingbot using Dock
It also contains standalone bash scripts that assist you to setting up Hummingbot with Docker, but we recommend using Docker Compose instead.
## Why use Docker Compose?
Using Docker for Hummingbot deployment offers several benefits, such as simplifying the installation process, enabling easy versioning and scaling, and ensuring a consistent and isolated environment for running the bot. This repository aims to help users get started with deploying Hummingbot using Docker by providing different examples that demonstrate how to set up and customize the bot according to their needs.
The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](./DOCKER.md) for more information about how to install and use Docker.
## How do I use this repo?

129
autostart_hummingbot_compose/README.md
View File

@@ -6,12 +6,7 @@ This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) in
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -29,7 +24,14 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
## Getting Started
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
Auto-starting a script/strategy lets you start a bot from the command line, skipping the Hummingbot UI.
To enable this, you will do need a few things first:
- Install and configure the Hummingbot instance
- Set the password used to encrypt your keys (`CONFIG_PASSWORD`)
- Define your script or strategy config file that you want to auto-start (`CONFIG_FILE_NAME`)
First, let's check that you have installed Docker Compose successfully. In Terminal/Bash, Run the following command:
```
docker compose
```
@@ -39,18 +41,16 @@ You should see a response that start with:
Usage: docker compose [OPTIONS] COMMAND
```
### 1. Launch network
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.
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 the "root folder" 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:
1. Set the password used to encrypt your keys (`CONFIG_PASSWORD`)
2. Define your script or strategy config file (`CONFIG_FILE_NAME`)
### 1. Set Hummingbot password
Pull the latest Hummingbot image and start it with the following command:
From the root folder, run the following command to pull the image and start the instance:
```
docker compose up -d
```
@@ -58,12 +58,22 @@ docker compose up -d
After the images have been downloaded, you should see the following output:
```
[+] Running 1/1
⠿ Container autostart_hummingbot_compose-bot-1 Started
⠿ Container hummingbot Started
```
Attach to the instance:
### 3. Set permissions
Run this command from your root folder to grant read/write permission to the `hummingbot_files` sub-folder:
```
docker attach autostart_hummingbot_compose-bot-1
sudo chmod -R a+rw ./hummingbot_files
```
### 4. Launch Hummingbot and set password
Now, attach to the `hummingbot` instance:
```
docker attach hummingbot
```
You should see the Hummingbot welcome screen:
@@ -72,23 +82,17 @@ You should see the Hummingbot welcome screen:
Set your Hummingbot [password](https://docs.hummingbot.org/operation/password/) and write it down. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file.
### 2. Define script/strategy file
Afterwards, run `exit` to exit Hummingbot.
You can auto-start either a Script or a Strategy.
[Scripts](https://docs.hummingbot.org/scripts/) are Python files that contain all strategy logic.
### 4. Define script/strategy file
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 `hummingbot_files/scripts` directory.
You can auto-start either a Script or a Strategy:
See [`simple_pmm_example.py`](./hummingbot_files/scripts/simple_pmm_example.py) for an example.
* [Scripts](https://docs.hummingbot.org/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 `hummingbot_files/scripts` directory. See [`simple_pmm_example.py`](./hummingbot_files/scripts/simple_pmm_example.py) for an example.
* [Strategies](https://docs.hummingbot.org/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 `hummingbot_files/conf/strategies` directory. See [`conf_pure_mm_1.yml`](./hummingbot_files/conf/strategies/conf_pure_mm_1.yml) for an example.
[Strategies](https://docs.hummingbot.org/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 `hummingbot_files/conf/strategies` directory.
See [`conf_pure_mm_1.yml`](./hummingbot_files/conf/strategies/conf_pure_mm_1.yml) for an example.
### 3. Modify YAML file
### 5. Modify YAML file
Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file.
@@ -112,66 +116,17 @@ Uncomment out:
- CONFIG_FILE_NAME=simple_pmm_example.py
```
Afterwards, save the file.
Afterwards, save the file.
### 6. Relaunch Hummingbot
### 4. Launch network
Now, the script or strategy will auto-start when you restart the Compose project
Restart the container using your new YAML file:
```
docker compose up -d
docker stop hummingbot
docker start hummingbot
```
You can attach to the container to inspect it running:
When you attach to it, the strategy or script should already be running:
```
docker attach autostart_hummingbot_compose-bot-1
```
## Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your containers:
### Create/Launch Compose project
```
docker compose up -d
```
### Remove 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 autostart_hummingbot_compose-bot-1
```
### Detach from the container and return to command line
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <instance-name>
```
### Remove a container
```
docker rm <instance-name>
docker attach hummingbot
```

3
autostart_hummingbot_compose/docker-compose.yml
View File

@@ -1,6 +1,7 @@
version: "3.9"
services:
bot:
hummingbot:
container_name: "hummingbot"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:

146
hummingbot_gateway_broker_compose/README.md
View File

@@ -9,11 +9,7 @@ This installs a [Hummingbot](https://github.com/hummingbot/hummingbot) instance
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -36,7 +32,15 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
## Getting Started
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
This configuration lets you orchestrate Hummingbot and Gateway instances using an EMQX broker.
To enable this, you will do need a few things first:
- Install and configure the Hummingbot and Gateway instances
- Generate self-signed certificates in Hummingbot
- Give Gateway the passphrase used to generate the certificates (`GATEWAY_PASSPHRASE`)
- Configure the EMQX broker
First, let's check that you have installed Docker Compose successfully. In Terminal/Bash, Run the following command:
```
docker compose
```
@@ -46,13 +50,12 @@ You should see a response that start with:
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.
### 1. Launch network
To link the Hummingbot and Gateway instances, you first have to generate certificates within Hummingbot and set the `GATEWAY_PASSPHRASE` variable in the YAML file.
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 the "root folder" where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
### 1. Generate certificates
Pull the latest Hummingbot and Gateway images and start instances with the following command:
From the root folder, run the following command to pull the images and start the instance:
```
docker compose up -d
```
@@ -61,14 +64,24 @@ After the images have been downloaded, you should see the following output:
```
[+] Running 4/4
⠿ Network hummingbot_gateway_broker_compose_default Created
⠿ Container hummingbot_gateway_broker_compose-gateway-1 Started
⠿ Container hummingbot_gateway_broker_compose-emqx-1 Started
⠿ Container hummingbot_gateway_broker_compose-bot-1 Started
⠿ Container hummingbot Started
⠿ Container gateway Started
⠿ Container emqx Started
```
Attach to the Hummingbot `bot` instance:
### 2. Set permissions
Run this command from your root folder to grant read/write permission to the `hummingbot_files` and `gateway_files` sub-folders:
```
docker attach hummingbot_gateway_broker_compose-bot-1
sudo chmod -R a+rw ./hummingbot_files ./gateway_files
```
### 3. Launch Hummingbot and generate certificates
Now, attach to the `hummingbot` instance:
```
docker attach hummingbot
```
You should see the Hummingbot welcome screen:
@@ -77,39 +90,35 @@ You should see the Hummingbot welcome screen:
Set your Hummingbot [password](https://docs.hummingbot.org/operation/password/) and write it down. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file.
Afterwards, run the following command to generate Gateway certificates:
Run the following command to generate Gateway certificates:
```
gateway generate-certs
```
You'll be prompted for a passphrase used to generate the certificates. This is the `GATEWAY_PASSPHRASE` environment variable in your `docker-compose.yml` file.
Afterwards, run `exit` to exit Hummingbot.
Afterwards, Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Now, run `exit` to exit the client.
### 2. Remove network
### 4. Remove network
Once you're back in Bash/Terminal, run the following command to remove the Compose project:
```
docker compose down
```
You should see the following output:
```
⠿ Container hummingbot_gateway_broker_compose-gateway-1 Removed
⠿ Container hummingbot_gateway_broker_compose-emqx-1 Removed
⠿ Container hummingbot_gateway_broker_compose-bot-1 Removed
⠿ Network hummingbot_gateway_broker_compose_default Removed
[+] Running 4/3
⠿ Container hummingbot Removed
⠿ Container gateway Removed
⠿ Container emqx Removed
⠿ Network hummingbot_gateway_broker_compose_default Removed
```
### 3. Modify YAML file
### 5. Modify YAML file
Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file.
Edit the section that defines the `CONFIG_PASSWORD` and `CONFIG_FILE_NAME` environment variables:
```yaml
bot:
hummingbot:
# environment:
# - CONFIG_PASSWORD=[password]
gateway:
@@ -141,85 +150,36 @@ Now, recreate the Compose project:
docker compose up -d
```
Attach to the Hummingbot `bot` instance:
Attach to the `hummingbot` instance. If you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
```
docker attach hummingbot_gateway_broker_compose-bot-1
docker attach hummingbot
```
After you enter your password, you should now see `GATEWAY:ONLINE` in the upper-right hand corner.
Open a new Terminal/Bash window. In it, attach to the Gateway `gateway` instance to see its logs:
```
docker attach hummingbot_gateway_compose-gateway-1
docker attach gateway
```
See [Gateway](https://docs.hummingbot.org/gateway/) for more details on how to configure it for use with Hummingbot.
To get started with Hummingbot, check out the following docs:
* [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)
### 5. Configure EMQX Broker
Attach to the EMQX Broker `emqx` instance:
```
docker attach hummingbot_gateway_broker_compose-emqx-1
docker attach emqx
```
After deploying for the first time, you can navigate to the EMQX dashboard to configure authentication and available ports at http://localhost:18083/.
Navigate to the EMQX dashboard to configure authentication and available ports at http://localhost:18083/.
The default credentials for connecting to the dashboards are `admin:public`.
For connecting your bots via MQTT, just leave the `mqtt_username` and `mqtt_password` parameters of the bot empty.
## Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your containers:
### Create/Launch Compose project
```
docker compose up -d
```
### Remove 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 Hummingbot container
```
docker attach hummingbot_gateway_broker_compose-bot-1
```
### Attach to the Gateway container
```
docker attach hummingbot_gateway_compose-gateway-1
```
### Attach to the EMQX Broker container
```
docker attach hummingbot_gateway_broker_compose-emqx-1
```
### Detach from the container and return to command line
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <instance-name>
```
### Remove a container
```
docker rm <instance-name>
```

7
hummingbot_gateway_broker_compose/docker-compose.yml
View File

@@ -1,6 +1,7 @@
version: "3.9"
services:
bot:
hummingbot:
container_name: "hummingbot"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:
@@ -11,6 +12,8 @@ services:
- "./hummingbot_files/data:/data"
- "./hummingbot_files/scripts:/scripts"
- "./hummingbot_files/certs:/certs"
# environment:
# - CONFIG_PASSWORD=[password]
logging:
driver: "json-file"
options:
@@ -21,6 +24,7 @@ services:
network_mode: host
gateway:
container_name: "gateway"
image: hummingbot/gateway:latest
# image: hummingbot/gateway:latest-arm
ports:
@@ -34,6 +38,7 @@ services:
# - GATEWAY_PASSPHRASE=[passphrase]
emqx:
container_name: "emqx"
image: emqx:5
restart: unless-stopped
environment:

97
hummingbot_gateway_compose/README.md
View File

@@ -6,12 +6,7 @@ This installs a [Hummingbot](https://github.com/hummingbot/hummingbot) instance
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -34,7 +29,14 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
## Getting Started
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
Installing Hummingbot alongside Gateway lets you access data and execute orders on DEX connectors.
To enable this, you will do need a few things first:
- Install and configure the Hummingbot and Gateway instances
- Generate self-signed certificates in Hummingbot
- Give Gateway the passphrase used to generate the certificates (`GATEWAY_PASSPHRASE`)
First, let's check that you have installed Docker Compose successfully. In Terminal/Bash, Run the following command:
```
docker compose
```
@@ -44,14 +46,12 @@ You should see a response that start with:
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.
To link the Hummingbot and Gateway instances, you first have to generate certificates within Hummingbot and set the `GATEWAY_PASSPHRASE` variable in the YAML file.
### 1. Launch network
Pull the latest Hummingbot and Gateway images and start instances with the following 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 the "root folder" where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
From the root folder, run the following command to pull the images and start the instance:
```
docker compose up -d
```
@@ -66,16 +66,16 @@ After the images have been downloaded, you should see the following output:
### 2. Set permissions
Run this command in root directory to grant read/write permission to the `hummingbot_files` and `gateway_files` folders:
Run this command from your root folder to grant read/write permission to the `hummingbot_files` and `gateway_files` sub-folders:
```
sudo chmod -R a+rw ./hummingbot_files ./gateway_files
```
### 3. Generate certificates
### 3. Launch Hummingbot and generate certificates
Now, attach to the Hummingbot `bot` instance:
Now, attach to the `hummingbot` instance:
```
docker attach hummingbot_gateway_compose-bot-1
docker attach hummingbot
```
You should see the Hummingbot welcome screen:
@@ -84,16 +84,16 @@ You should see the Hummingbot welcome screen:
Set your Hummingbot [password](https://docs.hummingbot.org/operation/password/) and write it down. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file.
Afterwards, run the following command to generate Gateway certificates:
Run the following command to generate Gateway certificates:
```
gateway generate-certs
```
You'll be prompted for a passphrase used to generate the certificates. This is the `GATEWAY_PASSPHRASE` environment variable in your `docker-compose.yml` file.
Afterwards, Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Now, run `exit` to exit the client.
Afterwards, run `exit` to exit Hummingbot.
### 4. Remove network
@@ -116,7 +116,7 @@ Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docke
Edit the section that defines the `CONFIG_PASSWORD` and `CONFIG_FILE_NAME` environment variables:
```yaml
bot:
hummingbot:
# environment:
# - CONFIG_PASSWORD=[password]
gateway:
@@ -131,7 +131,7 @@ Uncomment out:
The final `environment` section of the YAML file should look like this:
```yaml
bot:
hummingbot:
environment:
- CONFIG_PASSWORD=[password]
gateway:
@@ -148,7 +148,7 @@ Now, recreate the Compose project:
docker compose up -d
```
Attach to the `hummingbot` instance:
Attach to the `hummingbot` instance. If you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
```
docker attach hummingbot
```
@@ -160,51 +160,8 @@ docker attach gateway
```
See [Gateway](https://docs.hummingbot.org/gateway/) for more details on how to configure it for use with Hummingbot.
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/Launch Compose project
```
docker compose up -d
```
### Remove 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 a container
```
docker attach <container-name>
```
### Detach from a container and return to command line
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <container-name>
```
### Remove a container
```
docker rm <container-name>
```
* [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)

139
multiple_hummingbot_gateway_compose/README.md
View File

@@ -6,12 +6,7 @@ This installs two [Hummingbot](https://github.com/hummingbot/hummingbot) instanc
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -34,7 +29,14 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
## Getting Started
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully:
This configuration lets you deploy multiple Hummingbot instances that access data and execute orders on DEX connectors.
To enable this, you will do need a few things first:
- Install and configure the Hummingbot and Gateway instances
- Generate self-signed certificates in Hummingbot
- Give Gateway the passphrase used to generate the certificates (`GATEWAY_PASSPHRASE`)
First, let's check that you have installed Docker Compose successfully. In Terminal/Bash, Run the following command:
```
docker compose
```
@@ -44,13 +46,12 @@ You should see a response that start with:
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.
### 1. Launch network
To link the Hummingbot and Gateway instances, you first have to generate certificates within Hummingbot and set the `GATEWAY_PASSPHRASE` variable in the YAML file.
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 the "root folder" where your encrypted keys, scripts, trades, configs, logs, and other files related to your bots will be saved.
### 1. Generate certs
Pull the latest Hummingbot and Gateway images and start instances with the following command:
From the root folder, run the following command to pull the images and start the instance:
```
docker compose up -d
```
@@ -59,14 +60,23 @@ After the images have been downloaded, you should see the following output:
```
[+] Running 4/4
⠿ Network multiple_hummingbot_gateway_compose_default Created
⠿ Container multiple_hummingbot_gateway_compose-bot-1 Started
⠿ Container multiple_hummingbot_gateway_compose-bot2-1 Started
⠿ Container multiple_hummingbot_gateway_compose-gateway-1 Started
⠿ Container hummingbot-1 Started
⠿ Container hummingbot-2 Started
⠿ Container gateway Started
```
Attach to the `bot1` Hummingbot instance:
### 2. Set permissions
Run this command from your root folder to grant read/write permission to the `hummingbot_files` and `gateway_files` sub-folders:
```
docker attach multiple_hummingbot_gateway_compose-bot-1
sudo chmod -R a+rw ./hummingbot_files ./gateway_files
```
### 3. Launch Hummingbot and generate certificates
Now, attach to the `hummingbot-1` instance:
```
docker attach hummingbot-1
```
You should see the Hummingbot welcome screen:
@@ -75,18 +85,18 @@ You should see the Hummingbot welcome screen:
Set your [password](https://docs.hummingbot.org/operation/password/), which will be used to encrypt any keys you store with Hummingbot. This is the `CONFIG_PASSWORD` environment variable in your `docker-compose.yml` file.
Afterwards, run the following command to generate Gateway certificates:
Run the following command to generate Gateway certificates:
```
gateway generate-certs
```
You'll be prompted for a passphrase used to generate the certificates. This is the `GATEWAY_PASSPHRASE` environment variable in your `docker-compose.yml` file.
Afterwards, Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Hummingbot will use the passphrase to generate the certificates and save them in the `hummingbot_files/certs` folder, where the Gateway instance will look for the certificates it needs.
Now, run `exit` to exit the client.
Afterwards, run `exit` to exit Hummingbot.
### 2. Remove network
### 4. Remove network
Once you're back in Bash/Terminal, run the following command to remove the Compose project:
```
@@ -96,22 +106,22 @@ docker compose down
You should see the following output:
```
[+] Running 4/3
⠿ Container multiple_hummingbot_gateway_compose-bot-1 Removed
⠿ Container multiple_hummingbot_gateway_compose-bot2-1 Removed
⠿ Container multiple_hummingbot_gateway_compose-gateway-1 Removed
⠿ Network multiple_hummingbot_gateway_compose_default Removed
⠿ Container hummingbot-1 Removed
⠿ Container hummingbot-2 Removed
⠿ Container gateway Removed
⠿ Network multiple_hummingbot_gateway_compose_default Removed
```
### 3. Modify YAML file
### 5. Modify YAML file
Now, use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file.
We'll edit the section that defines the following environment variables:
```yaml
bot:
hummingbot-1:
# environment:
# - CONFIG_PASSWORD=[password]
bot2:
hummingbot-2:
# environment:
# - CONFIG_PASSWORD=[password]
gateway:
@@ -139,85 +149,34 @@ The final `environment` section of the YAML file should look like this:
Afterwards, save the file.
### 4. Recreate network
### 6. Recreate network
Now, recreate the Compose project:
```
docker compose up -d
```
Attach to the `bot` Hummingbot instance. Note that since you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
Attach to the `hummingbot-1` instance. If you have defined `CONFIG_PASSWORD` in the YAML file, you don't need to enter it again:
```
docker attach multiple_hummingbot_gateway_compose-bot-1
docker attach hummingbot-1
```
Similarly, you can attach to the `bot2` Hummingbot instance, which also uses `CONFIG_PASSWORD`
Similarly, you can attach to the `hummingbot-2` Hummingbot instance, which also uses `CONFIG_PASSWORD`
```
docker attach multiple_hummingbot_gateway_compose-bot2-1
docker attach hummingbot-2
```
In both instances, you should now see `GATEWAY:ONLINE` in the upper-right hand corner.
Open a new Terminal/Bash window. In it, attach to the Gateway instance to see its logs:
```
docker attach multiple_hummingbot_gateway_compose-gateway-1
docker attach gateway
```
See [Gateway](https://docs.hummingbot.org/gateway/) for more details on how to configure it for use with Hummingbot.
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/Launch Compose project
```
docker compose up -d
```
### Remove 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 Hummingbot containers
```
docker attach multiple_hummingbot_gateway_compose-gateway-1
docker attach multiple_hummingbot_gateway_compose-bot2-1
```
### Attach to the Gateway container
```
docker attach multiple_hummingbot_gateway_compose-gateway-1
```
### Detach from the container and return to command line
* Press keys <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### List all containers
```
docker ps -a
```
### Stop a container
```
docker stop <instance-name>
```
### Remove a container
```
docker rm <instance-name>
```
## Notes
To simplify the example, we are sharing the local `hummingbot_files` files between the two bots. Ideally, you should have a separate folder for each bot. However, the `certs` folder should be shared between all bots.
* [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)

7
multiple_hummingbot_gateway_compose/docker-compose.yml
View File

@@ -1,6 +1,7 @@
version: "3.9"
services:
bot:
hummingbot-1:
container_name: "hummingbot-1"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:
@@ -22,7 +23,8 @@ services:
stdin_open: true
network_mode: host
bot2:
hummingbot-2:
container_name: "hummingbot-2"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm
volumes:
@@ -45,6 +47,7 @@ services:
network_mode: host
gateway:
container_name: "gateway"
image: hummingbot/gateway:latest
# image: hummingbot/gateway:latest-arm
ports:

82
simple_hummingbot_compose/README.md
View File

@@ -6,12 +6,7 @@ This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) in
This configuration requires [Docker Compose](https://docs.docker.com/compose/), a tool for defining and running multi-container Docker applications. The recommended way to get Docker Compose is to install [Docker Desktop](https://www.docker.com/products/docker-desktop/), which includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites.
Docker Desktop is available on:
* [Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
See [Docker](../DOCKER.md) for more information about how to install and use Docker Compose, as well as helpful commands.
## Apple M1/M2 and other ARM machines
@@ -46,9 +41,9 @@ 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.
Alternatively, copy the `docker-compose.yml` file to a directory on your machine where you want to store your Hummingbot files. This is the "root folder" 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:
From the root folder, run the following command to pull the image and start the instance:
```
docker compose up -d
```
@@ -59,7 +54,16 @@ After the images have been downloaded, you should see the following output:
⠿ Container hummingbot Started
```
Attach to the instance:
### 2. Set permissions
Run this command from your root folder to grant read/write permission to the `hummingbot_files` sub-folder:
```
sudo chmod -R a+rw ./hummingbot_files
```
### 3. Launch Hummingbot
Attach to the `hummingbot` instance:
```
docker attach hummingbot
```
@@ -68,69 +72,9 @@ You should see the Hummingbot welcome screen:
![welcome screen](../welcome.png)
### 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:
* [Basic Features](https://docs.hummingbot.org/operation/)
* [Quickstart Guide](https://docs.hummingbot.org/quickstart/)
* [Hummingbot FAQ](https://docs.hummingbot.org/faq/)
## 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 <kbd>Ctrl</kbd> + <kbd>P</kbd> then <kbd>Ctrl</kbd> + <kbd>Q</kbd>
### 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>
```

2
simple_hummingbot_compose/docker-compose.yml
View File

@@ -1,6 +1,6 @@
version: "3.9"
services:
bot:
hummingbot:
container_name: "hummingbot"
image: hummingbot/hummingbot:latest
# image: hummingbot/hummingbot:latest-arm