gateway wip

autostart_hummingbot_compose/README.md

@@ -32,10 +32,14 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
 If you have installed Docker Compose successfully, the `docker-compose` command should be available in Terminal/Bash:
 ```
 docker-compose
+```
 
+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.
 
 ---

hummingbot_gateway_compose/README.md

@@ -1,6 +1,48 @@
-# Deploy: Hummingbot + Gateway
+# Deploy Hummingbot and Gateway Instances
 
-## How to use it
+This installs a [Hummingbot](https://github.com/hummingbot/hummingbot) instance linked to a [Hummingbot Gateway](https://github.com/hummingbot/hummingbot) as Docker containers.
+
+## Prerequisites
+
+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/)
+
+
+## Apple M1/M2 and other ARM machines
+
+If you have a recent Mac that uses Apple Silicon (M1/M2) chipset or another ARM-based machine, you need to change the image tag to ensure that you pull a container that is optimized for your chip architecture. 
+
+Use an IDE like [VSCode](https://code.visualstudio.com/) to edit the `docker-compose.yml` file. Change the the tag for both the Hummingbot and Gateway images from `latest` to `latest-arm` to pull the image built for ARM-based machines. 
+
+You can also comment out the line that contains `latest` and uncomment the lines that contains `latest-arm`:
+```
+# image: hummingbot/hummingbot:latest
+image: hummingbot/hummingbot:latest-arm
+
+# image: hummingbot/gateway:latest
+image: hummingbot/gateway:latest-arm
+```
+
+Afterwards, save the file and proceed to the next step.
+
+If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-based machine, you don't need to make any changes before deploying a container.
+
+## Getting Started
+
+If you have installed Docker Compose successfully, the `docker-compose` command should be available in Terminal/Bash:
+```
+docker-compose
+```
+
+You should see a response that start with:
+```
+Usage:  docker compose [OPTIONS] COMMAND
+```
 
 You will need to have the certificates for the gateway and hummingbot under the folder hummingbot_files/certs. If you don't have it, don't worry, you can generate them with the client by doing the following:
 

hummingbot_gateway_compose/docker-compose.yml

@@ -2,6 +2,7 @@ version: "3.9"
 services:
   bot:
     image: hummingbot/hummingbot:latest
+    # image: hummingbot/hummingbot:latest-arm
     volumes:
       - "./hummingbot_files/conf:/conf"
       - "./hummingbot_files/conf/connectors:/conf/connectors"
@@ -21,6 +22,7 @@ services:
 
   gateway:
     image: hummingbot/gateway:latest
+    # image: hummingbot/gateway:latest-arm
     ports:
       - "15888:15888"
       - "8080:8080"

simple_hummingbot_compose/README.md

@@ -32,7 +32,10 @@ If you are using a Mac with an Intel (x86) chipset, Windows or any other Intel-b
 If you have installed Docker Compose successfully, the `docker-compose` command should be available in Terminal/Bash:
 ```
 docker-compose
+```
 
+You should see a response that start with:
+```
 Usage:  docker compose [OPTIONS] COMMAND
 ```