d0zingcat/deploy
1
0
Fork 0
mirror of https://github.com/d0zingcat/deploy.git synced 2026-05-17 23:16:47 +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

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: