(docs) remove m1 docs, add linux compose install

This commit is contained in:
Michael Feng
2023-05-08 09:49:13 -07:00
parent 292f16163e
commit 54b903f969
7 changed files with 20 additions and 88 deletions

View File

@@ -4,7 +4,11 @@
Using Docker for Hummingbot deployment offers several benefits, such as simplifying the installation process, enabling easy versioning and scaling, and ensuring a consistent and isolated environment for running the bot. This repository aims to help users get started with deploying Hummingbot using Docker by providing different examples that demonstrate how to set up and customize the bot according to their needs.
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.
## Install Docker Compose
### 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:
@@ -12,6 +16,19 @@ Docker Desktop is available on:
* [Mac](https://docs.docker.com/desktop/install/mac-install/)
* [Windows](https://docs.docker.com/desktop/install/windows-install/)
### Ubuntu / Debian
```bash
sudo apt-get update
sudo apt-get install docker-compose-plugin
```
Verify that Docker Compose is installed correctly by checking the version:
```bash
docker compose version
```
## Useful Docker Commands
Use the commands below or use the Docker Desktop application to manage your containers:

View File

@@ -8,20 +8,6 @@ This configuration requires [Docker Compose](https://docs.docker.com/compose/),
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
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 image tag 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 line that contains `latest-arm`:
```
# image: hummingbot/hummingbot:latest
image: hummingbot/hummingbot: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
Auto-starting a script/strategy lets you start a bot from the command line, skipping the Hummingbot UI.

View File

@@ -11,25 +11,6 @@ This configuration requires [Docker Compose](https://docs.docker.com/compose/),
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
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 tag for **both** the Hummingbot and Gateway images from `latest` to `latest-arm` to pull the images built for ARM-based machines.
You can also comment out the each line that contains `latest` and uncomment each line 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
This configuration lets you orchestrate Hummingbot and Gateway instances using an EMQX broker.

View File

@@ -8,25 +8,6 @@ This configuration requires [Docker Compose](https://docs.docker.com/compose/),
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
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 tag for **both** the Hummingbot and Gateway images from `latest` to `latest-arm` to pull the images built for ARM-based machines.
You can also comment out the each line that contains `latest` and uncomment each line 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
Installing Hummingbot alongside Gateway lets you access data and execute orders on DEX connectors.

View File

@@ -8,25 +8,6 @@ This configuration requires [Docker Compose](https://docs.docker.com/compose/),
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
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 tag for **both** the Hummingbot and Gateway images from `latest` to `latest-arm` to pull the images built for ARM-based machines.
You can also comment out the each line that contains `latest` and uncomment each line 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
This configuration lets you deploy multiple Hummingbot instances that access data and execute orders on DEX connectors.

View File

@@ -29,8 +29,8 @@ services:
- "./hummingbot_files/data:/home/hummingbot/data"
- "./hummingbot_files/scripts:/home/hummingbot/scripts"
- "./hummingbot_files/certs:/home/hummingbot/certs"
environment:
- CONFIG_PASSWORD=a
# environment:
# - CONFIG_PASSWORD=[password]
logging:
driver: "json-file"
options:

View File

@@ -8,20 +8,6 @@ This configuration requires [Docker Compose](https://docs.docker.com/compose/),
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
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 image tag 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 line that contains `latest-arm`:
```
# image: hummingbot/hummingbot:latest
image: hummingbot/hummingbot: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
In Terminal/Bash, run the following command to check that you have installed Docker Compose successfully: