From 54866886f1396b93fcd9865a70f3ac4d3d065215 Mon Sep 17 00:00:00 2001 From: Michael Feng Date: Thu, 6 Apr 2023 13:49:28 -0700 Subject: [PATCH] improve intro --- README.md | 11 ++++++++--- autostart_hummingbot_compose/README.md | 5 +++++ hummingbot_gateway_broker_compose/README.md | 5 +++++ hummingbot_gateway_compose/README.md | 5 +++++ multiple_hummingbot_gateway_compose/README.md | 5 +++++ simple_hummingbot_compose/README.md | 5 +++++ 6 files changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ea46ab..27f1d10 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,19 @@ Docker Desktop is available on: * [Mac](https://docs.docker.com/desktop/install/mac-install/) * [Windows](https://docs.docker.com/desktop/install/windows-install/) -## Why does this repo contain? +## How do I use this repo? -Each folder showcases a different deployment type, such as running Hummingbot standalone, Hummingbot + Gateway, multiple instances, etc. The important files in each folder are: +Each folder showcases a different deployment type, 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 * `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. -## Deployment Types +## Deployment types using Docker Compose ### [Simple Hummingbot Compose](./simple_hummingbot_compose) diff --git a/autostart_hummingbot_compose/README.md b/autostart_hummingbot_compose/README.md index 22e9aa7..badf566 100644 --- a/autostart_hummingbot_compose/README.md +++ b/autostart_hummingbot_compose/README.md @@ -147,6 +147,11 @@ docker-compose down 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 diff --git a/hummingbot_gateway_broker_compose/README.md b/hummingbot_gateway_broker_compose/README.md index 9d416bd..bacd3f3 100644 --- a/hummingbot_gateway_broker_compose/README.md +++ b/hummingbot_gateway_broker_compose/README.md @@ -184,6 +184,11 @@ docker-compose down 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 diff --git a/hummingbot_gateway_compose/README.md b/hummingbot_gateway_compose/README.md index ce16d03..4061832 100644 --- a/hummingbot_gateway_compose/README.md +++ b/hummingbot_gateway_compose/README.md @@ -169,6 +169,11 @@ docker-compose down 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_compose-bot-1 diff --git a/multiple_hummingbot_gateway_compose/README.md b/multiple_hummingbot_gateway_compose/README.md index ad667f2..7b99005 100644 --- a/multiple_hummingbot_gateway_compose/README.md +++ b/multiple_hummingbot_gateway_compose/README.md @@ -183,6 +183,11 @@ docker-compose down 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 diff --git a/simple_hummingbot_compose/README.md b/simple_hummingbot_compose/README.md index 06cdfe6..ddfb3be 100644 --- a/simple_hummingbot_compose/README.md +++ b/simple_hummingbot_compose/README.md @@ -86,6 +86,11 @@ docker-compose down 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 simple_hummingbot_compose-bot-1