diff --git a/DOCKER.md b/DOCKER.md index 073030b..fa0ab91 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -6,29 +6,36 @@ Using Docker for Hummingbot deployment offers several benefits, such as simplify ## Install Docker Compose -### Installer +The examples below use Docker Compose, a tool for defining and running multi-container Docker applications. You can install Docker Compose either via command line or by running an installer. -Installing [Docker Desktop](https://www.docker.com/products/docker-desktop/) 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/) - -### Ubuntu / Debian +Linux (Ubuntu / Debian): ```bash sudo apt-get update sudo apt-get install docker-compose-plugin ``` +Mac (Homebrew): + +```bash +brew install docker-compose +``` + +If you want to be guided through the installation, install [Docker Desktop](https://www.docker.com/products/docker-desktop/) includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites: + +* [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/) + + Verify that Docker Compose is installed correctly by checking the version: ```bash docker compose version ``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. + ## Useful Docker Commands Use the commands below or use the Docker Desktop application to manage your containers: diff --git a/README.md b/README.md index 47aaf99..24bcdcb 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,33 @@ See [Docker](./DOCKER.md) for more information about how to install and use Dock ## How do I use this repo? -Each folder showcases a different deployment type, such as: +Each folder showcases a different deployment type using Docker Compose, such as: * A single Hummingbot instance * A single Hummingbot instance that auto-starts a strategy or script * Linked Hummingbot and Gateway instances * Multiple instances of Hummingbot The important files in each folder are: -* `docker-compose.yml`: A sample configuration file for that deployment type +* `docker-compose.yml`: A sample configuration file for that deployment type. * `README.md`: A detailed README file that guides users through the steps required to deploy Hummingbot using Docker, including how to build and run the containers, how to configure the bot, and how to monitor its performance. +After you have configured it properly, each deployment can be launched with the command: +``` +docker compose up -d +``` + ## Deployment types using Docker Compose ### [Simple Hummingbot Compose](./simple_hummingbot_compose) This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container. +### [Hummingbot with Dashboard](./hummingbot_with_dashboard) + +This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance with a companion [Hummingbot Dashboard](https://github.com/hummingbot/dashboard) running. + +Documentation coming soon. + ### [Autostart Hummingbot Compose](./autostart_hummingbot_compose) This installs a single [Hummingbot](https://github.com/hummingbot/hummingbot) instance as a Docker container and automatically starts running a pre-configured script or strategy. diff --git a/autostart_hummingbot_compose/README.md b/autostart_hummingbot_compose/README.md index e17f52a..6a5160b 100644 --- a/autostart_hummingbot_compose/README.md +++ b/autostart_hummingbot_compose/README.md @@ -17,15 +17,13 @@ To enable this, you will do need a few things first: - 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 +Verify that Docker Compose is installed correctly by checking the version: + +```bash +docker compose version ``` -You should see a response that start with: -``` -Usage: docker compose [OPTIONS] COMMAND -``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. ### 1. Launch network diff --git a/hummingbot_gateway_broker_compose/README.md b/hummingbot_gateway_broker_compose/README.md index 699eada..db6ac2e 100644 --- a/hummingbot_gateway_broker_compose/README.md +++ b/hummingbot_gateway_broker_compose/README.md @@ -21,15 +21,13 @@ To enable this, you will do need a few things first: - 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 +Verify that Docker Compose is installed correctly by checking the version: + +```bash +docker compose version ``` -You should see a response that start with: -``` -Usage: docker compose [OPTIONS] COMMAND -``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. ### 1. Launch network diff --git a/hummingbot_gateway_compose/README.md b/hummingbot_gateway_compose/README.md index 4d42c1d..644e70a 100644 --- a/hummingbot_gateway_compose/README.md +++ b/hummingbot_gateway_compose/README.md @@ -17,15 +17,13 @@ To enable this, you will do need a few things first: - 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 +Verify that Docker Compose is installed correctly by checking the version: + +```bash +docker compose version ``` -You should see a response that start with: -``` -Usage: docker compose [OPTIONS] COMMAND -``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. ### 1. Launch network diff --git a/multiple_hummingbot_gateway_compose/README.md b/multiple_hummingbot_gateway_compose/README.md index 4ba0650..ad179be 100644 --- a/multiple_hummingbot_gateway_compose/README.md +++ b/multiple_hummingbot_gateway_compose/README.md @@ -17,15 +17,14 @@ To enable this, you will do need a few things first: - 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 +Verify that Docker Compose is installed correctly by checking the version: + +```bash +docker compose version ``` -You should see a response that start with: -``` -Usage: docker compose [OPTIONS] COMMAND -``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. + ### 1. Launch network diff --git a/simple_hummingbot_compose/README.md b/simple_hummingbot_compose/README.md index e34d0bf..6bdfb46 100644 --- a/simple_hummingbot_compose/README.md +++ b/simple_hummingbot_compose/README.md @@ -10,15 +10,13 @@ See [Docker](../DOCKER.md) for more information about how to install and use Doc ## Getting Started -In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully: -``` -docker compose +Verify that Docker Compose is installed correctly by checking the version: + +```bash +docker compose version ``` -You should see a response that start with: -``` -Usage: docker compose [OPTIONS] COMMAND -``` +The output should be: `Docker Compose version v2.17.2` or similar. Ensure that you are using Docker Compose V2, as V1 is deprecated. ### 1. Launch network