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

Update README.md

Browse Source
This commit is contained in:
dardonacci
2023-02-23 16:40:14 -03:00
committed by GitHub
parent 535592578d
commit e478f0367d
1 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -7,7 +7,31 @@ The repository includes multiple Docker Compose files, each showcasing a differe
This repository is intended for developers and traders who want to deploy Hummingbot using Docker and explore its features and capabilities. Contributions are welcome, and users are encouraged to share their own examples and use cases for deploying Hummingbot with Docker..
## How to navigate the repo
Each folder has a different example of how to deploy Hummingbot.
1. **Bash scripts**:
Use this repository to create standalone containers of Hummingbot and Gateway. For example, you can run the client from the source and use the gateway with it by utilizing the gateway-create.sh file. 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
2. **Simple Hummingbot Compose**
This example creates a single Hummingbot container.
3. **Autostart Hummingbot Compose**
This example is a variation of the Simple Hummingbot Compose, with the ability to autostart a script or a strategy. The `.password_verification` file contains the encrypted password, which is `a`. Follow the Troubleshooting guide provided in the `README.md` file of that folder to understand how to change it and use your password. This folder also includes a script called `format_status.py`, and a `conf_pure_mm_1.yml` file inside the conf/strategies directory. These files are necessary to autostart the bot since the environment variables `CONFIG_PASSWORD` and `CONFIG_FILE_NAME` are essential.
4. **Hummingbot Gateway Compose**
This example shows how to run Hummingbot with Gateway with just one command. The only essential thing to consider is managing the certificates.
5. **Multiple Hummingbot Gateway Compose**
This example demonstrates how to run multiple Hummingbot instances with Gateway with just one command. The only essential thing to consider is managing the certificates.
## IMPORTANT
All the docker-compose files are using hummingbot/hummingbot:latest and hummingbot/gateway:latest as images to create the containers. If you are using a machine with ARM I strongly recommend you to build your local image by cloning the official repository and then running:
All the docker-compose files use hummingbot/hummingbot:latest and hummingbot/gateway:latest as images to create the containers. If you are using a machine with ARM, we strongly recommend building your local image by cloning the official repository and running the command:
```
docker build -f Dockerfile.arm -t hummingbot/hummingbot:arm .
This will build the image for your architecture and the performance will be better.
```